Skip to main content
GET
/
v1
/
{org_uid}
/
assets
/
list
Returns list of assets with aggregated data
curl --request GET \
  --url https://client.synack.com/api/streaming/v1/{org_uid}/assets/list \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "attributes": "<unknown>",
    "id": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    },
    "meta": "<unknown>",
    "relationships": {},
    "type": "asset_list"
  },
  "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

Query Parameters

​
type[]
enum<string>[]

Assets Type [ip, fqdn, app]

Available options:
ip,
fqdn,
app
​
location
string

Assets Location [location] or Technologies [technologies]

​
listing_uids[]
string[]

Listing UIDs

​
open_ports[]
string[]

Filter by Open Ports on an asset. If given 0 all assets that have been fingerprinted but no ports were found will be returned.

​
providers[]
string[]

Providers

​
scan_status[]
enum<string>[]

Last Scan Status [in-progress failed finished new]

Available options:
in-progress,
failed,
finished,
new
​
test_statuses[]
enum<string>[]

Last Test Status [active scheduled completed paused_manually paused_by_outage_window]

Available options:
active,
scheduled,
completed,
paused_manually,
paused_by_outage_window
​
last_tested
enum<string>

Last Tested ['Last 30 days' 'Last 90 days' 'Last 180 days' 'Over 180 days' 'Never']

Available options:
Last 30 days,
Last 90 days,
Last 180 days,
Over 180 days,
Never
​
suspected_vuln_avg_cvss[]
string[]

Suspected Vulnerability CVSS Range [0.0-0.0, 0.1-3.9, 4.0-6.9, 7.0-8.9, 9.0-10.0]

​
vuln_avg_cvss[]
string[]

Vulnerability CVSS Range [0.0-0.0, 0.1-3.9, 4.0-6.9, 7.0-8.9, 9.0-10.0]

​
seed_groups[]
string[]

Seed Groups using seed group uid

​
origin[]
enum<string>[]

Origin [provided discovered]

Available options:
provided,
discovered
​
lifecycle_state[]
enum<string>[]

Lifecycle State [confirmed unconfirmed ignored archived]

Available options:
confirmed,
unconfirmed,
ignored,
archived
​
gateway_ids[]
string[]

Gateway IDs

​
gateway_names
string[]

Gateway Names

​
tag_uids[]
string[]

Tag UIDs

​
criticalities[]
enum<string>[]

Criticality [undefined low medium high]

Available options:
undefined,
low,
medium,
high
​
scanned
enum<string>

Scanned assets [true false]

Available options:
,
​
waf
enum<string>

WAF [detected not-detected]

Available options:
detected,
not-detected
​
reachability[]
enum<string>[]

Reachability [reachable blocked-by-waf unreachable http-status-code-4xx-5xx reachability-pending not-applicable not-determined]

Available options:
reachable,
blocked-by-waf,
unreachable,
http-status-code-4xx-5xx,
reachability-pending,
not-applicable,
not-determined
​
order_by
enum<string>
default:location

Order By [location provider scan_status test_status suspected_vuln_count vuln_count last_scan_status_ts last_test_status_ts suspected_vuln_avg_cvss vuln_avg_cvss software last_seen waf, created_at, criticality]

Available options:
location,
provider,
scan_status,
test_status,
suspected_vuln_count,
vuln_count,
last_scan_status_ts,
last_test_status_ts,
suspected_vuln_avg_cvss,
vuln_avg_cvss,
software,
last_seen,
waf,
created_at,
criticality
​
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

​
export
enum<string>

Export data [csv]

Available options:
csv
​
columns[]
string[]

Columns to be returned

​
sources[]
enum<string>[]

Sources [provided fractalScan xpanse cloudEnumeration fingerprinter]

Available options:
provided,
fractalScan,
xpanse,
cloudEnumeration,
fingerprinter

Response

OK

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