How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Synack Assets API

Assets managed by Synack.

Synack Assets API is one of 22 APIs that Synack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Assets. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 28 operations across 24 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://client.synack.com/api/asset, https://client.synack.us/api/asset, https://client.synack.com/api/streaming, https://client.synack.us/api/streaming.

28 operations 24 paths 96 schemas 1 DELETE21 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.synack.com
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Synack Assets API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the implicit flow, exposing 11 scopes. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 28

Across 24 paths, the API surfaces 28 operations — 1 DELETE, 21 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Assets 28

Assets managed by Synack.

POST
/v2/bulk/assets
Creates Assets in my Synack org. Note: In the Body, choose the Object pull down that corresponds to the asset type you want to add; Object 1 for Cloud, Object 2 for Hosts, Object 3 for Mobile, Object…
postAssetBulk body → 201202401403409413422500
POST
/v2/bulk/assets/lifecycle-state:update
Bulk updates the asset life cycle property. Checks the validity of assets and returns 409 Conflict if rules are violated.
bulkUpdateAssetLifecycleState body → 200202401403409413422500
POST
/v2/bulk/assets/criticality:update
Bulk update the criticality of multiple assets.
bulkUpdateAssetCriticality body → 200202401403409413422500
GET
/v2/assets
Retrieve the list of assets for one or more organizations, considering filtering and pagination query parameters. When an organization-level OAuth2 scope is provided, the results will be restricted t…
getAssets 30 params → 200400401403500503
POST
/v2/assets
Creates an asset in my Synack org. In the Body, choose the Object pull down that corresponds to the asset type you want to add; Object 1 for Cloud, Object 2 for Host, Object 3 for Mobile, Object 4 fo…
postAsset body → 201202401403409413422500
GET
/v2/assets/{assetUid}/whois
Retrieves the WHOIS data for a single asset.
getWHOIS 1 param → 200
PUT
/v2/assets/{assetUid}/whois
Adds the WHOIS data to a single asset.
putWHOIS 1 param body → 200
GET
/v2/assets/{assetUid}
Retrieves a single asset. If the user is a researcher, only the credentials they are authorized to access will be returned. If the asset is of cloud account type, only a user with assetscangr scope c…
getAsset 2 params → 200401403404500503
PATCH
/v2/assets/{assetUid}
Patches the properties of a single asset.
patchAsset 1 param body → 200401403404500503
DELETE
/v2/assets/{assetUid}
Deletes an asset. This is intended to be a privileged operation. Regular use should be to mark the asset as inactive. Any relationships that involve the deleted asset will be also be deleted, as will…
deleteAsset 1 param → 204401403404500503
GET
/v2/assets/{assetUid}/related-assets
Returns all assets that share a relationship with the matched Asset UID.
getRelatedAssets 2 params → 200401404500503
GET
/v2/assets/{assetUid}/tools/burp/target-scope.json
Retrieve a Burp target scope file, if the asset is a webapp.
getBurpTargetScopeForAsset 1 param → 200401403404500503
GET
/v2/assets/{assetUid}/ports/{portNumber}/{portProtocol}
Retrieve a port for a host asset.
getHostPort 3 params → 200401403404503
GET
/v2/asset-stats
Returns active assets under test (in scope for a listing) and total active assets for the supplied organization and listings.
getAssetStats 2 params → 200400401403500503
GET
/v2/organizations/{organizationUid}/discovered-assets
Retrieve the list summarized properties for discovered assets belonging to an organization, considering filtering and pagination query parameters. Additional query parameters generally restrict the r…
getDiscoveredAssetSummaries 10 params → 200400401403500503
GET
/v1/{org_uid}/assets/{asset_uid}/ports
Returns list of ports per organization and asset
getAssetPorts 8 params → 200400401500
GET
/v1/{org_uid}/assets/{asset_uid}/whois
Returns whois data for a given asset UID
getAssetWhois 2 params → 200400401500
GET
/v1/{org_uid}/assets/detail/{asset_uid}
Returns Assets Details for a given Organization and Assets UID
getAssetDetails 2 params → 200400401404500
GET
/v1/{org_uid}/assets/list
Returns list of assets with aggregated data
getAssetList 28 params → 200400401500
GET
/v1/{org_uid}/assets/ports
Returns list of asset ports
getAssetPortsByOrg 2 params → 200400401500
GET
/v1/{org_uid}/metrics/assets/count
Returns count of assets by type
getAssetsCount 3 params → 200400401500
GET
/v1/{org_uid}/metrics/assets/any_scan
Returns last fingerprint scan date for assets
getLastAssetsScan 3 params → 200400401500
GET
/v1/{org_uid}/metrics/assets/last_tested
Returns the count of last tested assets by asset criticality
getLastTestedCounts 3 params → 200400401500
GET
/v1/{org_uid}/metrics/assets/latest
Returns the 5 most recently created assets
getMostRecentlyAddedAssets 3 params → 200400401500
GET
/v1/{org_uid}/metrics/ips/vulnerable
Returns ip address sorted by most vulnerable
getTopVulnerableIPs 3 params → 200400401500
GET
/v1/{org_uid}/metrics/ports/unique
Returns top-5 most unique (least-common) ports
getTopUniquePorts 3 params → 200400401500
GET
/v1/{org_uid}/metrics/ports/vulnerable
Returns top-5 most vulnerable ports
getTopVulnerablePorts 3 params → 200400401500
GET
/v1/{org_uid}/assets/gateways
Returns list of asset gateways
getAssetGateways 2 params → 200400401500

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are HTTPingSettings (10 properties), ProblemDetails (9 properties), DiscoveredAssetsTotals (6 properties), Data (6 properties). Each schema is shown below with its type and property counts.

CheckerStatus
string
Status reported by automated checkers.
CloudAccountAsset
PortProtocol
string
AuthenticationStrategy
WebRULE
string
Rule for web asset validation
CredentialSharing
string
Determines the limits on users that may be assigned; "one" permits only one user to be assigned, "many" places no limit, and "all" prevents any users to explic…
CriticalityUpdateCount
object
1 property
ArrayOfRelatedAssets
array
CredentialCounts
object
Credential counts by credential status in context of a user role.
3 properties
RelatedAsset
object
4 properties
ProblemDetails
object
See [RFC 7807: Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807)
9 properties
OrganizationUID
string
Unique identifier for an organization.
ArrayOfAssetSummaries
array
ErrorCode
integer
Optional numeric error code set by an automated process such as scanning or checking.
GatewayID
string
Identifier for Launchpoint-managed VPN gateway.
OperatingSystem
object
2 properties
Scripts
object
Map of scripts used by this strategy, keyed by script role.
3 properties
NetworkRef
object
Reference to the network that an asset can be found on. The asset in question and the network must belong to the same organization. Deprecating.
1 property
ScanState
string
Scan state of asset.
AssetUID
string
Unique identifier for an asset.
ApplicationAsset
object
1 property
MobileApplicationProperties
AssetTypeTotal
object
3 properties 3 required
FailedValidation
object
3 properties 1 required
AssetBulkCriticalityUpdate
object
3 properties 3 required
DiscoveredByRelationship
Relationship indicating the source asset was discovered by scanning the target asset. Discovered-by relationships extend the uniqueness constraint to allow mul…
ScopeRuleApplicability
string
HTTPingSettings_Headers
object
1 property
CloudCredentialFormat
string
Describes format of the cloud credential
AssetGateway
object
Gateways and listings the asset is assigned to.
2 properties
MobileApplicationAsset
AssetOrigin
string
Indicates the origin for the asset, i.e. whether the asset was provided manually or it was discovered by some sort of automation.
SingleOrMultiAsset
WebApplicationAsset
OperationUserUID
string
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…
CloudAccountProperties
object
Keeps credentials for accessing the cloud provider. Mandatory for assets of 'cloudaccount' type.
3 properties 3 required
ExternalUID
string
Unique identifier for an external entity. It has much more loose requirements than AssetUID since in general we don't control these external services.
Creatable
object
2 properties 2 required
UserRoleScript
AssetLifecycleState
string
Indicates the asset position in asset lifecycle FSM.
MobileOperatingSystem
string
The operating system for the asset.
AssetSummary
Asset
SeedUID
string
Unique identifier for an E-ASM seed.
WHOIS
string
Whois results.
HostAsset
Port
AssetRelationshipType
string
Type or relationship between assets.
WebApplicationProperties
ScopeRuleInclusion
string
ListingUID
string
Unique identifier for an listing.
ApplicationBinary
object
2 properties
Scope
string
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 thro…
NetworkProperties
object
1 property
UserRoleCredentialSummary
object
Credential used by an application in context of a user role.
4 properties
AssetStat
object
Stats for assets within a single organization.
1 property
WHOISRequest
object
Whois request data.
1 property
IpRange
string
IP Range could be a CIDR or an IP Range
UserUID
string
Unique identifier for a user.
AssetBulkLifecycleStateUpdate
object
3 properties 3 required
HostProperties
AssetCriticality
string
Indicates importance of the asset to the customer.
Updatable
PortNumber
integer
NetworkAsset
UserRole
LifecycleUpdateCount
object
1 property
SingleAssetRelationship
CloudPlatform
string
Identifies cloud platform
Base64Data
string
Base64 encoding of data.
SingleAsset
IndexedFailedValidations
object
2 properties
ScopeRule
DiscoveredAssetsPage
object
2 properties
AssetRelationship
A relationship between two assets. Generally the relationship may be read as source-asset relationship-type target-asset. There cannot be multiple relationship…
AssetListing
object
Listings the asset is assigned to.
5 properties
UID
string
Unique Identifier.
AssetChangeStatus
string
Indicates whether the asset is newly discovered, has changed since last evaluated, or is unchanged.
ArrayOfAssets
array
HostType
string
DiscoveredAssetsTotals
object
6 properties
ArrayOfIpRanges
array
ExternalRelationship
A relationship between two assets. Source asset points to an asset in AssetService assets table while Target asset points to some external asset stored outside…
AssetRelationshipUID
string
Unique identifier for a scan.
PortObservedState
string
Observed state reported by automated scanning.
AuthenticationStrategies
object
Map of authentication strategies for various scanners, keyed by asset scanner name.
2 properties
ScopeRuleSummary
object
Part of the scope of an asset that is included/excluded from a specific activity.
4 properties 4 required
HTTPingSettings
object
HTTPingSettings represents custom settings for webapp reachability checks. All fields are optional.
10 properties
AssetType
string
WHOISResponse
object
Whois data.
2 properties
Relationship
object
2 properties
Data
object
6 properties
Links
object
2 properties
Error
object
5 properties
Document
object
5 properties
ResourceType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synack-assets-api-openapi.yml Raw ↑

Other APIs Synack publishes across the network.

Synack Assessment Groups API
Synack Assessment Lifecycle API
Synack Assessments API
Synack asset-relationships API
Synack assetproviders API
Synack Comments API
Synack credentials API
Synack external-relationships API
Synack health API
Synack Hosts API
Synack Missions API
Synack mobileapps API
Where this information came from

This is an independent, third-party profile of Synack Assets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.