Assets

Create asset software

Create a software

post/assets/software

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Request body

projectIdsstring[] nullable

The list of project IDs bind the asset on.

namestring nullable

The custom name of the asset. If not provided, the default name will be used.

asset_class'TECHNOLOGY' required
extra_metadataobject nullable
screenshot_s3_keystring nullable
asset_type'SOFTWARE' required
technology_keystring required
versionstring nullable
reference_urlstring nullable
cpestring nullable
cpe_guessedboolean nullable
well_known_technology'REDIS' | 'NGINX' | 'APACHE' | 'REACT' | 'ANGULAR' | 'VUE' | 'SVELTE' | 'null' nullable
descriptionstring nullable

Example request

{
  "name": "My Asset"
}

Response

OK

idstring uuid required

The id of the asset

class'API_SERVICE' | 'CDN' | 'CLOUD_COMPONENT' | 'CLOUD_HOSTING' | 'CODE_PROJECT' | 'CSPM' | 'DEV_TOOLS' | 'FRONTEND' | 'HOST' | 'MOBILE_APP' | 'NETWORK' | 'REPOSITORY' | 'SCHEMA' | 'SOURCE_CODE_MANAGEMENT' | 'TECHNOLOGY' required
type'APK' | 'AWS_LAMBDA' | 'BITBUCKET_REPOSITORY' | 'BURPSUITE_EXPORT' | 'CODE_PROJECT' | 'DNS' | 'GITHUB_REPOSITORY' | 'GITLAB_REPOSITORY' | 'GRAPHQL' | 'GRAPHQL_SCHEMA' | 'GRPC' | 'HAR_EXPORT' | 'INSOMNIA' | 'IPV4' | 'IPV4_RANGE' | 'IPV6' | 'MCP' | 'OPENAPI' | 'PACKAGE' | 'POSTMAN_COLLECTION' | 'POSTMAN_ENVIRONMENT' | 'REST' | 'SOAP' | 'SOFTWARE' | 'WEBAPP' | 'WEBSOCKET' | 'WP_JSON' required
namestring required

The name of the asset

externalUrlstring nullable required

The external url of the asset

faviconUrlstring nullable required

The favicon url of the asset

descriptionstring nullable required

The description of the asset

createdAtstring required

The date and time the asset was created

lastSeenAtstring required

The date and time the asset was last seen

scheduledForDeletionAtstring nullable required

The date and time the asset is scheduled for deletion

status'DEPRECATED' | 'FALSE_POSITIVE' | 'MONITORED' | 'OUT_OF_SCOPE' | 'THIRD_PARTY' required

The status of the asset

ownersstring[]

The owners of the asset

risksstring[] required

The risks of the asset

projectIdsstring[] required

IDs of the projects this asset is assigned to

schemaUrlstring nullable required

Time-limited HTTPS URL for schema-class assets; null for other asset classes

rawDataunknown
metadatastring[]

Metadata flags for the asset

Changes

No recorded changes to this operation across all 1 revision of this API.