Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowImplicit
Authorization URL
login.synack.com
Scopes3
asset_gr
Grants unrestricted read access to all assets. Except for credential data of cloud accout assets.
asset_or
Grants organization-level read access for all types of assets owned by a particular organization.
asset_lr
Grants per-listing read access for all types of assets.

Path Parameters

assetUid
string
required

Unique identifier for an asset.

Pattern: ^[0-9a-f]{24}
portNumber
integer<int32>
required

Port number.

Required range: 0 <= x <= 65535
portProtocol
enum<string>
required

Port protocol.

Available options:
tcp,
udp

Response

The current state of a host port.

scope
enum<string>
required

Set to in-scope means automated and manual testing should occur; out-of-scope means automated and manual testing must not occur; discovered means observed through automated discovery and may be automatically removed if not observed again during subseqent discovery activities.

Available options:
in,
out,
discovered,
blocked
observedState
enum<string>
required

Observed state reported by automated scanning.

Available options:
open,
closed,
filtered
createdAt
string<date-time>
required
read-only

Automatically set by the server to the time the request was processed whenever the resource was created.

createdBy
string
required
read-only

Automatically set by the server to the requesting user whenever the resource is updated. May be a user account or a service account if the action is performed by an automated.

Pattern: ^[0-9a-f]{12}
number
integer<int32>
Required range: 0 <= x <= 65535
protocol
enum<string>
Available options:
tcp,
udp
service
string

Name of (expected) service running on port. Will use the Service Name and Transport Protocol Port Number Registry for well-known ports.

detectedService
string
read-only

Name of detected service running on port according to fingerprinting.

detectedProductName
string
read-only

Name of software product running on port according to fingerprinting.

detectedProductVersion
string
read-only

Version of software product running on port according to fingerprinting.

detectedProductConfidenceLevel
integer<int>
read-only

Confidence level of detected product on port according to fingerprinting.

Required range: 1 <= x <= 10
detectedProductCPE
string
read-only

CPE for detected product according to fingerprinting.

serviceBanner
string
read-only

Port banner according to fingerprinting.

updatedAt
string<date-time>
read-only

Automatically set by the server to the time the request was processed whenever the resource is updated.

updatedBy
string
read-only

Automatically set by the server to the requesting user whenever the resource is updated. May be a user account or a service account if the action is performed by an automated.

Pattern: ^[0-9a-f]{12}