Patch Asset

Authorizations

Authorization

string

header

required

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

Path Parameters

assetUid

string

required

Unique identifier for an asset.

Body

application/json

Asset properties to patch.

Option 1
Option 2
Option 3
Option 4
Option 5

organizationUid

string

required

Unique identifier for an organization.

assetType

enum<string>

required

Derived from the properties associated with the asset.

Available options:

cloudaccount,

host,

network,

mobileapp,

webapp

origin

enum<string>

default:provided

required

Indicates the origin for the asset, i.e. whether the asset was provided manually or it was discovered by some sort of automation.

Available options:

provided,

discovered

inProduction

boolean

default:true

Indicates whether the asset resides in a production environment.

active

boolean

default:true

Active assets may participate in listings. When inactive, the asset is essentially soft-deleted and may not be scanned or subject to new research by SRT.

label

string

Optional label for the asset. If present, label is part of the derived property of asset location, which enables creation of multiple assets with different labels under a single organization.

description

string

Optional description for the asset.

lifecycleState

enum<string>

default:confirmed

Indicates the asset position in asset lifecycle FSM.

Available options:

confirmed,

unconfirmed,

ignored,

archived

criticality

enum<string>

default:undefined

Indicates importance of the asset to the customer.

Available options:

high,

medium,

low,

undefined

changeStatus

enum<string>

default:unchanged

Indicates whether the asset is newly discovered, has changed since last evaluated, or is unchanged.

Available options:

new,

changed,

unchanged

anyListingActive

boolean

default:false

This field is used for scheduling Fingerprinting scans. A calculated field based on if the asset has any listings in which it is active. This field is read only and relates only to assets created after Apr 1 2023.

anyListingActiveWithin2Years

boolean

default:false

This field is used for scheduling Fingerprinting scans. A calculated field based on if the asset has any active listings or listings deactivated less than 2 years ago. This field is read only and relates only to assets created prior to Apr 1 2023.

scanStateUpdatedAt

string<date-time>

The date time the scan state was updated.

lastCheckedAt

string<date-time>

The last date time the asset was checked.

lastReachableAt

string<date-time>

The last date time the asset was successfully checked for reachability.

lastSuccessfulScan

string<date-time>

The last date time the asset scan was successful.

lastFailedScan

string<date-time>

The last date time the asset scan was failed.

firstSeen

string<date-time>

For assets with an origin of discovered. The date time when the asset was first discovered.

lastSeen

string<date-time>

For assets with an origin of discovered. The date time when the asset was last discovered or fingerprinted.

status

enum<string>

Status reported by automated checkers.

Available options:

unchecked,

invalid,

valid

errorCode

integer<int32>

Optional numeric error code set by an automated process such as scanning or checking.

sourceRelationships

object[]

Relationships which have this asset as a source (SourceAssetID and SourceAssetUID will be set automatically). This property is only available in the postAssetBulk request body and is not returned as part of any responses.

Show child attributes

sourceRelationships.sourceAssetUid

string

required

Unique identifier for an asset.

sourceRelationships.targetAssetUid

string

required

Unique identifier for an asset.

sourceRelationships.startsAt

string<date-time>

required

The date-time at which the relationship between the source and target asset is observed to first begin.

sourceRelationships.relationshipType

enum<string>

required

Type or relationship between assets.

Available options:

discoveredBy

sourceRelationships.assetScanner

enum<string>

required

The asset-scanner that discovered the relationship.

Available options:

burp,

cloudEnumeration,

masscan,

nessus,

openVAS,

tarantulaBurpV2,

cidrExpansion,

amass,

fingerprinter,

easm

sourceRelationships.uid

string

Unique identifier for a scan.

sourceRelationships.endsAt

string<date-time>

The date-time at which the relationship between the source and target asset was observed to end.

externalRelationships

object[]

External relationships which this asset participates in as a source. When used in postAssetBulk request, AssetID and AssetUID will be set automatically.

Show child attributes

externalRelationships.type

enum<string>

required

Type of relationship between assets. The direction of reading is sourceAsset -- type -- targetAsset.

Available options:

discoveredBy

externalRelationships.sourceAssetUid

string

required

Unique identifier for an asset.

externalRelationships.targetUid

string

required

Unique identifier for an external entity. It has much more loose requirements than AssetUID since in general we don't control these external services.

externalRelationships.targetService

enum<string>

required

The type of the external service, holding the "target" entity.

Available options:

assetDiscovery,

fractalScan,

xpanse

externalRelationships.startsAt

string<date-time>

required

The date-time at which the relationship between the source and target assets was observed to begin.

externalRelationships.uid

string

Unique identifier for a scan.

externalRelationships.endsAt

string<date-time>

The date-time at which the relationship between the source and target assets was observed to end.

cloudAccount

object

Keeps credentials for accessing the cloud provider. Mandatory for assets of 'cloudaccount' type.

Show child attributes

cloudAccount.credentialData

string

required

Base64 encoding of data.

Example:

"TXkgdm9pY2UgaXMgbXkgcGFzc3dvcmQu"

cloudAccount.cloudPlatform

enum<string>

required

Identifies cloud platform

Available options:

aws,

azure,

gcp

cloudAccount.cloudCredentialFormat

enum<string>

required

Describes format of the cloud credential

Available options:

aws_assume_role,

aws_secret_access,

azure_certificate,

azure_password,

gcp_cloud_asset,

gcp_compute_engine

Response

The current state of the requested asset.

Option 1
Option 2
Option 3
Option 4
Option 5

organizationUid

string

required

Unique identifier for an organization.

assetType

enum<string>

required

Derived from the properties associated with the asset.

Available options:

cloudaccount,

host,

network,

mobileapp,

webapp

origin

enum<string>

default:provided

required

Indicates the origin for the asset, i.e. whether the asset was provided manually or it was discovered by some sort of automation.

Available options:

provided,

discovered

createdAt

string<date-time>

required

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

createdBy

string

required

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.

uid

string

Unique Identifier.

location

string

Derived human-readable text representation of the asset, based on assetType and other properties.

inProduction

boolean

default:true

Indicates whether the asset resides in a production environment.

active

boolean

default:true

Active assets may participate in listings. When inactive, the asset is essentially soft-deleted and may not be scanned or subject to new research by SRT.

label

string

Optional label for the asset. If present, label is part of the derived property of asset location, which enables creation of multiple assets with different labels under a single organization.

description

string

Optional description for the asset.

lifecycleState

enum<string>

default:confirmed

Indicates the asset position in asset lifecycle FSM.

Available options:

confirmed,

unconfirmed,

ignored,

archived

criticality

enum<string>

default:undefined

Indicates importance of the asset to the customer.

Available options:

high,

medium,

low,

undefined

changeStatus

enum<string>

default:unchanged

Indicates whether the asset is newly discovered, has changed since last evaluated, or is unchanged.

Available options:

new,

changed,

unchanged

anyListingActive

boolean

default:false

anyListingActiveWithin2Years

boolean

default:false

scanStateUpdatedAt

string<date-time>

The date time the scan state was updated.

lastCheckedAt

string<date-time>

The last date time the asset was checked.

lastReachableAt

string<date-time>

The last date time the asset was successfully checked for reachability.

lastSuccessfulScan

string<date-time>

The last date time the asset scan was successful.

lastFailedScan

string<date-time>

The last date time the asset scan was failed.

firstSeen

string<date-time>

For assets with an origin of discovered. The date time when the asset was first discovered.

lastSeen

string<date-time>

For assets with an origin of discovered. The date time when the asset was last discovered or fingerprinted.

status

enum<string>

Status reported by automated checkers.

Available options:

unchecked,

invalid,

valid

errorCode

integer<int32>

Optional numeric error code set by an automated process such as scanning or checking.

listings

object[]

Array of listings the asset belongs to.

Show child attributes

listings.listingUid

string

Unique identifier for an listing.

listings.scope

enum<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 through automated discovery and may be automatically removed if not observed again during subseqent discovery activities.

Available options:

in,

out,

discovered,

blocked

listings.scopeRules

object[]

Out of scope locations for this asset.

Show child attributes

listings.scopeRules.uid

string

required

Unique Identifier.

listings.scopeRules.rule

string

required

A textual definition of the scope rule. Format will vary by assetType.

listings.scopeRules.scope

enum<string>

required

Available options:

in,

out

listings.scopeRules.appliesTo

enum<string>

required

Available options:

scanners,

srt,

both

listings.scopeRules.createdAt

string<date-time>

required

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

listings.scopeRules.createdBy

string

required

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.

listings.scopeRules.updatedAt

string<date-time>

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

listings.scopeRules.updatedBy

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 by an automated.

listings.createdAt

string<date-time>

Automatically set by the server to the time the listing asset association was created.

listings.updatedAt

string<date-time>

Automatically set by the server to the time the listing asset association is updated.

scopeRules

object[]

Rules that modify the scope of security research for this asset.

Show child attributes

scopeRules.uid

string

required

Unique Identifier.

scopeRules.rule

string

required

A textual definition of the scope rule. Format will vary by assetType.

scopeRules.scope

enum<string>

required

Available options:

in,

out

scopeRules.appliesTo

enum<string>

required

Available options:

scanners,

srt,

both

relationships

object[]

Relationships which this asset participates in, either as a source or as a target.

Show child attributes

relationships.sourceAssetUid

string

required

Unique identifier for an asset.

relationships.targetAssetUid

string

required

Unique identifier for an asset.

relationships.startsAt

string<date-time>

required

The date-time at which the relationship between the source and target asset is observed to first begin.

relationships.relationshipType

enum<string>

required

Type or relationship between assets.

Available options:

discoveredBy

relationships.createdAt

string<date-time>

required

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

relationships.createdBy

string

required

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.

relationships.assetScanner

enum<string>

required

The asset-scanner that discovered the relationship.

Available options:

burp,

cloudEnumeration,

masscan,

nessus,

openVAS,

tarantulaBurpV2,

cidrExpansion,

amass,

fingerprinter,

easm

relationships.uid

string

Unique identifier for a scan.

relationships.endsAt

string<date-time>

The date-time at which the relationship between the source and target asset was observed to end.

relationships.updatedAt

string<date-time>

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

relationships.updatedBy

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 by an automated.

externalRelationships

object[]

External relationships which this asset participates in as a source. When used in postAssetBulk request, AssetID and AssetUID will be set automatically.

Show child attributes

externalRelationships.type

enum<string>

required

Type of relationship between assets. The direction of reading is sourceAsset -- type -- targetAsset.

Available options:

discoveredBy

externalRelationships.sourceAssetUid

string

required

Unique identifier for an asset.

externalRelationships.targetUid

string

required

Unique identifier for an external entity. It has much more loose requirements than AssetUID since in general we don't control these external services.

externalRelationships.targetService

enum<string>

required

The type of the external service, holding the "target" entity.

Available options:

assetDiscovery,

fractalScan,

xpanse

externalRelationships.startsAt

string<date-time>

required

The date-time at which the relationship between the source and target assets was observed to begin.

externalRelationships.createdAt

string<date-time>

required

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

externalRelationships.createdBy

string

required

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.

externalRelationships.uid

string

Unique identifier for a scan.

externalRelationships.endsAt

string<date-time>

The date-time at which the relationship between the source and target assets was observed to end.

externalRelationships.updatedAt

string<date-time>

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

externalRelationships.updatedBy

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 by an automated.

gateways

object[]

Array of Launchpoint-managed VPN gateways per listing.

Show child attributes

gateways.gatewayId

string

Identifier for Launchpoint-managed VPN gateway.

gateways.listingUid

string

Unique identifier for an listing.

updatedAt

string<date-time>

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

updatedBy

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 by an automated.

cloudAccount

object

Keeps credentials for accessing the cloud provider. Mandatory for assets of 'cloudaccount' type.

Show child attributes

cloudAccount.credentialData

string

required

Base64 encoding of data.

Example:

"TXkgdm9pY2UgaXMgbXkgcGFzc3dvcmQu"

cloudAccount.cloudPlatform

enum<string>

required

Identifies cloud platform

Available options:

aws,

azure,

gcp

cloudAccount.cloudCredentialFormat

enum<string>

required

Describes format of the cloud credential

Available options:

aws_assume_role,

aws_secret_access,

azure_certificate,

azure_password,

gcp_cloud_asset,

gcp_compute_engine

Asset Management v2 API

Vulnerability Management API

Asset Tagging v1 API

Platform v1 API

Query API v1

Authorizations

Path Parameters

Body

Response