Get Ports for a Host Asset - Synack Enterprise API

GET

{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>"
}

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

data

object

Show child attributes

errors

object[]

Show child attributes

included

any[]

links

object

Show child attributes

meta

any

Get WHOIS for a Host AssetGet `whois` data by asset UID

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>"
}