Escape Workflows API
Workflows Management The public API provides CRUDs operations to manage workflows.
OpenAPI Specification
openapi: 3.1.0
info:
version: 3.0.0
title: Escape Public Asm Workflows API
description: 'This API enables you to operate [Escape](https://escape.tech/) programmatically.
All requests must be authenticated with a valid API key, provided in the `X-ESCAPE-API-KEY` header.
For example: `X-ESCAPE-API-KEY: YOUR_API_KEY`.
You can find your API key in the [Escape dashboard](https://app.escape.tech/user/).'
servers:
- url: https://public.escape.tech/v3
security:
- apiKey: []
tags:
- name: Workflows
description: 'Workflows Management
The public API provides CRUDs operations to manage workflows.'
paths:
/workflows:
get:
tags:
- Workflows
summary: List workflows.
operationId: listWorkflows
description: List and search workflows of the organization.
parameters:
- schema:
type: string
description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
example: R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
required: false
description: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
name: cursor
in: query
- schema:
type: integer
minimum: 1
maximum: 100
default: 50
description: The number of items to return per page
example: 50
required: false
description: The number of items to return per page
name: size
in: query
- schema:
type: string
enum:
- CREATED_AT
- NAME
description: The type to sort by
required: false
description: The type to sort by
name: sortType
in: query
- schema:
type: string
enum:
- asc
- desc
default: asc
description: The direction to sort by
required: false
description: The direction to sort by
name: sortDirection
in: query
- schema:
type: array
items:
type: string
format: uuid
description: Filter by workflow IDs
required: false
description: Filter by workflow IDs
name: workflowIds
in: query
- schema:
type: array
items:
type: string
format: uuid
description: Filter by project IDs
required: false
description: Filter by project IDs
name: projectIds
in: query
- schema:
type: array
items:
type: string
format: uuid
description: Filter by integration IDs
required: false
description: Filter by integration IDs
name: integrationIds
in: query
- schema:
type: array
items:
type: string
enum:
- ASSET_FOUND
- ASSET_UPDATED
- INTEGRATION_FAILED
- ISSUE_UPDATED
- LOCATION_DOWN
- MANUAL
- NEW_ISSUE
- SCAN_COMPLETED
- SCAN_FAILED
- SCAN_STARTED
description: Filter by triggers
required: false
description: Filter by triggers
name: triggers
in: query
- schema:
type: string
description: Search term to filter integrations by name or description
example: my integration
required: false
description: Search term to filter integrations by name or description
name: search
in: query
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
nextCursor:
type:
- string
- 'null'
totalCount:
type: integer
default: 100
example: 20
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
default: 00000000-0000-0000-0000-000000000000
description: The workflow ID.
name:
type: string
default: Workflow Name
description: The name of the workflow.
trigger:
type: string
enum:
- ASSET_FOUND
- ASSET_UPDATED
- INTEGRATION_FAILED
- ISSUE_UPDATED
- LOCATION_DOWN
- MANUAL
- NEW_ISSUE
- SCAN_COMPLETED
- SCAN_FAILED
- SCAN_STARTED
throttleMs:
type:
- number
- 'null'
description: The throttle in milliseconds for the workflow.
filters:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- ASSETS
- EVENTS
- INTEGRATIONS
- ISSUES
- LOCATIONS
- PROFILES
- SCANS
filter: {}
view:
type:
- object
- 'null'
properties:
id:
type: string
format: uuid
name:
type: string
target:
type: string
enum:
- ASSETS
- EVENTS
- INTEGRATIONS
- ISSUES
- LOCATIONS
- PROFILES
- SCANS
data: {}
required:
- id
- name
- target
required:
- id
- type
- view
actions:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
type:
type: string
enum:
- ACT
- EXPORT
- NOTIFY
parameters: {}
internalAction:
type:
- string
- 'null'
enum:
- UPDATE_ASSET
- UPDATE_ISSUE
- null
integration:
type:
- object
- 'null'
properties:
id:
type: string
format: uuid
name:
type: string
kind:
type: string
enum:
- AKAMAI
- AWS
- AZURE
- BITBUCKET_REPO
- CLOUDFLARE
- CUSTOM
- DISCORD_WEBHOOK
- DNS
- EMAIL
- GCP
- GITHUB_API_KEY
- GITLAB_API_KEY
- JIRA
- KUBERNETES
- POSTMAN_API_KEY
- SLACK_WEBHOOK
- TEAMS_WEBHOOK
- WEBHOOK
- WIZ
required:
- id
- name
- kind
required:
- id
- type
- internalAction
- integration
required:
- trigger
- throttleMs
- filters
- actions
title: WorkflowSummarized
description: Summarized information about a workflow
required:
- nextCursor
- data
'400':
description: Pagination error
content:
application/json:
schema:
type: object
properties:
message:
type: string
enum:
- Invalid cursor
details:
type: string
required:
- message
- details
title: PaginationError
description: Returned when an invalid pagination cursor is supplied
post:
tags:
- Workflows
summary: Create workflows.
operationId: createWorkflow
description: Create a workflow.
requestBody:
content:
application/json:
schema:
type: object
properties:
organizationId:
type: string
format: uuid
description: The organization ID to create the workflow for
name:
type: string
description: The name of the workflow
trigger:
type: string
enum:
- ASSET_FOUND
- ASSET_UPDATED
- INTEGRATION_FAILED
- ISSUE_UPDATED
- LOCATION_DOWN
- MANUAL
- NEW_ISSUE
- SCAN_COMPLETED
- SCAN_FAILED
- SCAN_STARTED
throttleMs:
type:
- number
- 'null'
description: The throttle in milliseconds for the workflow.
filters:
type: array
items:
anyOf:
- type: object
properties:
viewId:
type: string
format: uuid
required:
- viewId
title: Create workflow filter using view
- type: object
properties:
type:
type: string
enum:
- ISSUES
filter:
type: object
properties:
severities:
type:
- array
- 'null'
items:
type: string
enum:
- INFO
- LOW
- MEDIUM
- HIGH
- CRITICAL
risks:
type:
- array
- 'null'
items:
type: string
enum:
- UNAUTHENTICATED
- SENSITIVE_DATA
- CRITICAL_FINDING
- PROD_ONLY_MODE
- EXPOSED
- OPEN_SCHEMA
- PRIVATE
projectIds:
type:
- array
- 'null'
items:
type: string
applicationIds:
type:
- array
- 'null'
items:
type: string
description: Deprecated, use profileIds instead
profileIds:
type:
- array
- 'null'
items:
type: string
assetIds:
type:
- array
- 'null'
items:
type: string
jiraTicket:
type:
- boolean
- 'null'
search:
type:
- string
- 'null'
categories:
type:
- array
- 'null'
items:
type: string
enum:
- ACCESS_CONTROL
- CONFIGURATION
- INFORMATION_DISCLOSURE
- SENSITIVE_DATA
- INJECTION
- PROTOCOL
- REQUEST_FORGERY
- RESOURCE_LIMITATION
- SCHEMA
- CUSTOM
scannerKinds:
type:
- array
- 'null'
items:
type: string
enum:
- FRONTEND_DAST
- BLST_REST
- BLST_GRAPHQL
- ASM_DNS
- ASM_IPV4
- ASM_IPV6
- ASM_IPV4_RANGE
- ASM_REST
- ASM_GRAPHQL
- ASM_WEBAPP
- ASM_GRPC
- ASM_WEBSOCKET
- ASM_MCP
- ASM_SOAP
- ASM_AWS_ACCOUNT
- AUTOMATED_PENTEST_WEBAPP
- AUTOMATED_PENTEST_REST
- AUTOMATED_PENTEST_GRAPHQL
- ASM_AKAMAI_ACCOUNT
- ASM_CLOUDFLARE_ACCOUNT
- ASM_GCP_PROJECT
- ASM_KUBERNETES_CLUSTER
- ASM_AZURE_TENANT
- ASM_WIZ_ACCOUNT
- ASM_POSTMAN_ORGANIZATION
- ASM_GITLAB_REPOSITORY
- ASM_GITHUB_REPOSITORY
- ASM_BITBUCKET_REPOSITORY
- ASM_GITLAB_GROUP
- ASM_GITHUB_ORGANIZATION
- ASM_BITBUCKET_ORGANIZATION
- ASM_GRAPHQL_SCHEMA
- ASM_OPENAPI
- ASM_POSTMAN_COLLECTION
- ASM_POSTMAN_ENVIRONMENT
- ASM_WP_JSON
- ASM_INSOMNIA
- ASM_BURPSUITE_EXPORT
- ASM_HAR_EXPORT
- ASM_CODE_PROJECT
- ASM_AWS_LAMBDA
- ASM_PACKAGE
- ASM_SOFTWARE
assetClasses:
type:
- array
- 'null'
items:
type: string
enum:
- API_SERVICE
- FRONTEND
- HOST
- CLOUD_HOSTING
- CDN
- CSPM
- DEV_TOOLS
- NETWORK
- REPOSITORY
- SOURCE_CODE_MANAGEMENT
- SCHEMA
- CODE_PROJECT
- CLOUD_COMPONENT
- TECHNOLOGY
assetTypes:
type:
- array
- 'null'
items:
type: string
enum:
- DNS
- IPV4
- IPV6
- IPV4_RANGE
- REST
- GRAPHQL
- WEBAPP
- GRPC
- MCP
- WEBSOCKET
- SOAP
- AWS_ACCOUNT
- AKAMAI_ACCOUNT
- CLOUDFLARE_ACCOUNT
- GCP_PROJECT
- KUBERNETES_CLUSTER
- AZURE_TENANT
- WIZ_ACCOUNT
- POSTMAN_ORGANIZATION
- GITLAB_REPOSITORY
- GITHUB_REPOSITORY
- BITBUCKET_REPOSITORY
- GITLAB_GROUP
- GITHUB_ORGANIZATION
- BITBUCKET_ORGANIZATION
- GRAPHQL_SCHEMA
- OPENAPI
- POSTMAN_COLLECTION
- POSTMAN_ENVIRONMENT
- WP_JSON
- INSOMNIA
- BURPSUITE_EXPORT
- HAR_EXPORT
- CODE_PROJECT
- AWS_LAMBDA
- PACKAGE
- SOFTWARE
tagIds:
type:
- array
- 'null'
items:
type: string
noTags:
type:
- boolean
- 'null'
scanIds:
type:
- array
- 'null'
items:
type: string
securityTestUids:
type:
- array
- 'null'
items:
type: string
status:
type:
- array
- 'null'
items:
type: string
enum:
- OPEN
- RESOLVED
- MANUAL_REVIEW
- IGNORED
- FALSE_POSITIVE
ids:
type:
- array
- 'null'
items:
type: string
blacklistedIds:
type:
- array
- 'null'
items:
type: string
fullNames:
type:
- array
- 'null'
items:
type: string
blacklistedNames:
type:
- array
- 'null'
items:
type: string
assetStatuses:
type:
- array
- 'null'
items:
type: string
enum:
- DEPRECATED
- OUT_OF_SCOPE
- FALSE_POSITIVE
- MONITORED
- THIRD_PARTY
aiFalsePositive:
type:
- boolean
- 'null'
agentic:
type:
- boolean
- 'null'
targetIds:
type:
- array
- 'null'
items:
type: string
domains:
type:
- array
- 'null'
items:
type: string
ignoreInventory:
type:
- boolean
- 'null'
ignored:
type:
- boolean
- 'null'
required:
- type
- filter
title: Create workflow filter using custom filter on issues
- type: object
properties:
type:
type: string
enum:
- PROFILES
filter:
type: object
properties:
ids:
type:
- array
- 'null'
items:
type: string
search:
type:
- string
- 'null'
risks:
type:
- array
- 'null'
items:
type: string
enum:
- UNAUTHENTICATED
- SENSITIVE_DATA
- CRITICAL_FINDING
- PROD_ONLY_MODE
- EXPOSED
- OPEN_SCHEMA
- PRIVATE
tagIds:
type:
- array
- 'null'
items:
type: string
noTags:
type:
- boolean
- 'null'
projectIds:
type:
- array
- 'null'
items:
type: string
noProjects:
type:
- boolean
- 'null'
assetIds:
type:
- array
- 'null'
items:
type: string
assetSchemaIds:
type:
- array
- 'null'
items:
type: string
issueIds:
type:
- array
- 'null'
items:
type: string
kinds:
type:
- array
- 'null'
items:
type: string
enum:
- FRONTEND_DAST
- BLST_REST
- BLST_GRAPHQL
- ASM_DNS
- ASM_IPV4
- ASM_IPV6
- ASM_IPV4_RANGE
- ASM_REST
- ASM_GRAPHQL
- ASM_WEBAPP
- ASM_GRPC
- ASM_WEBSOCKET
- ASM_MCP
- ASM_SOAP
- ASM_AWS_ACCOUNT
- AUTOMATED_PENTEST_WEBAPP
- AUTOMATED_PENTEST_REST
- AUTOMATED_PENTEST_GRAPHQL
- ASM_AKAMAI_ACCOUNT
- ASM_CLOUDFLARE_ACCOUNT
- ASM_GCP_PROJECT
- ASM_KUBERNETES_CLUSTER
- ASM_AZURE_TENANT
- ASM_WIZ_ACCOUNT
- ASM_POSTMAN_ORGANIZATION
- ASM_GITLAB_REPOSITORY
- ASM_GITHUB_REPOSITORY
- ASM_BITBUCKET_REPOSITORY
- ASM_GITLAB_GROUP
- ASM_GITHUB_ORGANIZATION
- ASM_BITBUCKET_ORGANIZATION
- ASM_GRAPHQL_SCHEMA
- ASM_OPENAPI
- ASM_POSTMAN_COLLECTION
- ASM_POSTMAN_ENVIRONMENT
- ASM_WP_JSON
- ASM_INSOMNIA
- ASM_BURPSUITE_EXPORT
- ASM_HAR_EXPORT
- ASM_CODE_PROJECT
- ASM_AWS_LAMBDA
- ASM_PACKAGE
- ASM_SOFTWARE
domains:
type:
- array
- 'null'
items:
type: string
initiators:
type:
- array
- 'null'
items:
type: string
enum:
- APPLICATION_CREATION
- CI
- MANUAL
- SCHEDULED
- INVENTORY
- UNKNOWN
lastScanStatuses:
type:
- array
- 'null'
items:
type: string
enum:
- STARTING
- RUNNING
- CANCELED
- FINISHED
- FAILED
problemSeverities:
type:
- array
- 'null'
items:
type: string
enum:
- INFO
- WARNING
- ERROR
problemCodes:
type:
- array
- 'null'
items:
type: string
enum:
- PL_FAILURE
# --- truncated at 32 KB (254 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/escape/refs/heads/main/openapi/escape-workflows-api-openapi.yml