Skip to main content
GET
/
v1
/
{org_uid}
/
assets
/
{asset_uid}
/
ports
Returns list of ports per organization and asset
curl --request GET \
  --url https://client.synack.com/api/streaming/v1/{org_uid}/assets/{asset_uid}/ports \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "attributes": "<unknown>",
    "id": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    },
    "meta": "<unknown>",
    "relationships": {}
  },
  "errors": [
    {
      "detail": "<string>",
      "id": "<string>",
      "source": "<string>",
      "status": 123,
      "title": "<string>"
    }
  ],
  "included": [
    "<unknown>"
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>"
  },
  "meta": "<unknown>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.synack.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
org_uid
string
required

Organization UID

​
asset_uid
string
required

Asset UID

Query Parameters

​
observed_state
enum<string>
default:open

Observed State [open closed]

Available options:
open,
closed
​
limit
integer

Maximum number of port results to be returned

​
order_by
enum<string>
default:number

Order By [number service_name service_banner]

Available options:
number,
service_name,
service_banner
​
order_direction
enum<string>
default:ASC

Order Direction [ASC DESC]

Available options:
ASC,
DESC
​
per_page
integer

Maximum number of results to be returned

​
page
integer

If provided, show the provided page

Response

OK

​
data
object
​
errors
object[]
​
included
any[]
​
links
object
​
meta
any