ESescape
Assets

Update an asset

Update an asset by ID

put/assets/{assetId}

Request

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

Path parameters

assetIdstring required

The asset ID

Example:00000000-0000-0000-0000-000000000000

Request body

projectIdsstring[]

The project IDs of the asset

framework'FRONTEND_ANGULAR' | 'FRONTEND_DJANGO' | 'FRONTEND_JAVASCRIPT' | 'FRONTEND_JQUERY' | 'FRONTEND_REACT' | 'FRONTEND_SVELTE' | 'FRONTEND_VUE' | 'GRAPHQL_APOLLO' | 'GRAPHQL_GRAPHQLYOGA' | 'REST_ASP_NET' | 'REST_CLOJURE' | 'REST_DJANGO' | 'REST_EXPRESS_JS' | 'REST_FASTAPI' | 'REST_FLASK' | 'REST_GIN' | 'REST_HONO' | 'REST_LARAVEL' | 'REST_NESTJS' | 'REST_NEXTJS' | 'REST_NUXTJS' | 'REST_RUBY_ON_RAILS' | 'REST_SCALA_PLAY' | 'REST_SPRING_BOOT' | 'REST_SYMFONY' | 'UNKNOWN'

The framework of the asset

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

The status of the asset

descriptionstring

The description of the asset

namestring nullable

The custom name of the asset

environment'DEVELOPMENT' | 'PRODUCTION' | 'STAGING' | 'UNKNOWN'

The environment of the asset

manuallySetStatusboolean

Whether the status was manually set

baseUrlstring

The base URL of the asset (for SCHEMA assets)

addressstring

The address of the asset (for HOST assets)

dataJsonStrstring

JSON-encoded asset data

bestSchemaIdstring

The ID of the best schema (for API_SERVICE assets)

schemaIdsstring[]

The IDs of the schemas (for API_SERVICE assets)

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.