Escape Public API

naftiko: 1.0.0-alpha2
info:
  label: Escape Public 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/).'
  tags:
  - Escape
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: escape
    baseUri: https://public.escape.tech/v3
    description: Escape Public API HTTP API.
    authentication:
      type: apikey
      in: header
      name: X-ESCAPE-API-KEY
      value: '{{ESCAPE_TOKEN}}'
    resources:
    - name: profiles
      path: /profiles
      operations:
      - name: listprofiles
        method: GET
        description: List profiles
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: assetIds
          in: query
          type: string
          description: Filter by asset IDs
        - name: domains
          in: query
          type: string
          description: Filter by domain
        - name: issueIds
          in: query
          type: string
          description: Filter by issue IDs
        - name: tagIds
          in: query
          type: string
          description: Filter by tag IDs
        - name: search
          in: query
          type: string
          description: Search term to filter profiles by name or description
        - name: initiators
          in: query
          type: array
          description: Filter by initiator
        - name: kinds
          in: query
          type: array
          description: Filter by kind
        - name: risks
          in: query
          type: array
          description: Filter by risk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-problems
      path: /profiles/problems
      operations:
      - name: problems
        method: GET
        description: List all scan statuses and problems
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: assetIds
          in: query
          type: string
          description: Filter by asset IDs
        - name: domains
          in: query
          type: string
          description: Filter by domain
        - name: issueIds
          in: query
          type: string
          description: Filter by issue IDs
        - name: tagIds
          in: query
          type: string
          description: Filter by tag IDs
        - name: search
          in: query
          type: string
          description: Search term to filter profiles by name or description
        - name: initiators
          in: query
          type: array
          description: Filter by initiator
        - name: kinds
          in: query
          type: array
          description: Filter by kind
        - name: risks
          in: query
          type: array
          description: Filter by risk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-profileid
      path: /profiles/{profileId}
      operations:
      - name: getprofile
        method: GET
        description: Get a profile
        inputParameters:
        - name: profileId
          in: path
          type: string
          required: true
          description: The profile ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateprofile
        method: PUT
        description: Update a profile
        inputParameters:
        - name: profileId
          in: path
          type: string
          required: true
          description: The profile ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteprofile
        method: DELETE
        description: Delete a profile
        inputParameters:
        - name: profileId
          in: path
          type: string
          required: true
          description: The profile ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-profileid-configuration
      path: /profiles/{profileId}/configuration
      operations:
      - name: updateprofileconfiguration
        method: PUT
        description: Update profile configuration
        inputParameters:
        - name: profileId
          in: path
          type: string
          required: true
          description: The profile ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-profileid-schema
      path: /profiles/{profileId}/schema
      operations:
      - name: updateprofileschema
        method: PUT
        description: Update profile schema
        inputParameters:
        - name: profileId
          in: path
          type: string
          required: true
          description: The profile ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-rest
      path: /profiles/rest
      operations:
      - name: createdastrestprofile
        method: POST
        description: Create a DAST REST profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-graphql
      path: /profiles/graphql
      operations:
      - name: createdastgraphqlprofile
        method: POST
        description: Create a DAST GraphQL profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-webapp
      path: /profiles/webapp
      operations:
      - name: createdastwebappprofile
        method: POST
        description: Create a DAST WebApp profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-ai-pentesting-rest
      path: /profiles/ai-pentesting/rest
      operations:
      - name: createpentestrestprofile
        method: POST
        description: Create an Automated Pentest REST profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-ai-pentesting-graphql
      path: /profiles/ai-pentesting/graphql
      operations:
      - name: createpentestgraphqlprofile
        method: POST
        description: Create an Automated Pentest GraphQL profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: profiles-ai-pentesting-webapp
      path: /profiles/ai-pentesting/webapp
      operations:
      - name: createpentestwebappprofile
        method: POST
        description: Create an Automated Pentest WebApp profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: authentications
      path: /authentications
      operations:
      - name: startauthentication
        method: POST
        description: Start an authentication configuration check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: authentications-authenticationid
      path: /authentications/{authenticationId}
      operations:
      - name: getauthentication
        method: GET
        description: Get authentication configuration check status
        inputParameters:
        - name: authenticationId
          in: path
          type: string
          required: true
          description: Identifier returned by the start endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets
      path: /assets
      operations:
      - name: listassets
        method: GET
        description: List assets
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: search
          in: query
          type: string
          description: Search term to filter assets by name or description
        - name: types
          in: query
          type: array
          description: Filter by type
        - name: statuses
          in: query
          type: array
          description: Filter by status
        - name: manuallyCreated
          in: query
          type: string
          description: Filter by manually created
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-bulk-update
      path: /assets/bulk-update
      operations:
      - name: bulkupdateassets
        method: POST
        description: Bulk update assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-bulk-delete
      path: /assets/bulk-delete
      operations:
      - name: bulkdeleteassets
        method: POST
        description: Bulk delete assets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-assetid
      path: /assets/{assetId}
      operations:
      - name: getasset
        method: GET
        description: Get an asset
        inputParameters:
        - name: assetId
          in: path
          type: string
          required: true
          description: The asset ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateasset
        method: PUT
        description: Update an asset
        inputParameters:
        - name: assetId
          in: path
          type: string
          required: true
          description: The asset ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteasset
        method: DELETE
        description: Delete an asset
        inputParameters:
        - name: assetId
          in: path
          type: string
          required: true
          description: The asset ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-assetid-activities
      path: /assets/{assetId}/activities
      operations:
      - name: listassetactivities
        method: GET
        description: List activities of an asset
        inputParameters:
        - name: assetId
          in: path
          type: string
          required: true
          description: The asset ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createassetcomment
        method: POST
        description: Comment on an asset
        inputParameters:
        - name: assetId
          in: path
          type: string
          required: true
          description: The asset ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-dns
      path: /assets/dns
      operations:
      - name: createasset-dns
        method: POST
        description: Create asset dns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-ipv4
      path: /assets/ipv4
      operations:
      - name: createasset-ipv4
        method: POST
        description: Create asset ipv4
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-ipv6
      path: /assets/ipv6
      operations:
      - name: createasset-ipv6
        method: POST
        description: Create asset ipv6
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-graphql
      path: /assets/graphql
      operations:
      - name: createasset-graphql
        method: POST
        description: Create asset graphql
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-rest
      path: /assets/rest
      operations:
      - name: createasset-rest
        method: POST
        description: Create asset rest
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-grpc
      path: /assets/grpc
      operations:
      - name: createasset-grpc
        method: POST
        description: Create asset grpc
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-websocket
      path: /assets/websocket
      operations:
      - name: createasset-websocket
        method: POST
        description: Create asset websocket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-mcp
      path: /assets/mcp
      operations:
      - name: createasset-mcp
        method: POST
        description: Create asset mcp
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-soap
      path: /assets/soap
      operations:
      - name: createasset-soap
        method: POST
        description: Create asset soap
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-webapp
      path: /assets/webapp
      operations:
      - name: createasset-webapp
        method: POST
        description: Create asset webapp
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-azure-tenant
      path: /assets/azure-tenant
      operations:
      - name: createasset-azure-tenant
        method: POST
        description: Create asset azure-tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-ipv4-range
      path: /assets/ipv4-range
      operations:
      - name: createasset-ipv4-range
        method: POST
        description: Create asset ipv4-range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-gitlab-repository
      path: /assets/gitlab-repository
      operations:
      - name: createasset-gitlab-repository
        method: POST
        description: Create asset gitlab-repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-github-repository
      path: /assets/github-repository
      operations:
      - name: createasset-github-repository
        method: POST
        description: Create asset github-repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-bitbucket-repository
      path: /assets/bitbucket-repository
      operations:
      - name: createasset-bitbucket-repository
        method: POST
        description: Create asset bitbucket-repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-code-project
      path: /assets/code-project
      operations:
      - name: createasset-code-project
        method: POST
        description: Create asset code-project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-aws-lambda
      path: /assets/aws-lambda
      operations:
      - name: createasset-aws-lambda
        method: POST
        description: Create asset aws-lambda
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-package
      path: /assets/package
      operations:
      - name: createasset-package
        method: POST
        description: Create asset package
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-software
      path: /assets/software
      operations:
      - name: createasset-software
        method: POST
        description: Create asset software
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: assets-schema
      path: /assets/schema
      operations:
      - name: createasset-schema
        method: POST
        description: Create asset schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans
      path: /scans
      operations:
      - name: listscans
        method: GET
        description: List scans
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: after
          in: query
          type: string
          description: Filter by after date
        - name: before
          in: query
          type: string
          description: Filter by before date
        - name: assetIds
          in: query
          type: string
          description: Filter by asset IDs
        - name: profileIds
          in: query
          type: string
          description: Filter by profile IDs
        - name: ignored
          in: query
          type: string
          description: Filter by ignored status
        - name: initiator
          in: query
          type: array
          description: Filter by initiator
        - name: kinds
          in: query
          type: array
          description: Filter by kind
        - name: status
          in: query
          type: array
          description: Filter by status
        - name: projectIds
          in: query
          type: string
          description: Filter by project IDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: startscan
        method: POST
        description: Start a new scan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-problems
      path: /scans/problems
      operations:
      - name: scansproblems
        method: GET
        description: List scans with their problems
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: after
          in: query
          type: string
          description: Filter by after date
        - name: before
          in: query
          type: string
          description: Filter by before date
        - name: assetIds
          in: query
          type: string
          description: Filter by asset IDs
        - name: profileIds
          in: query
          type: string
          description: Filter by profile IDs
        - name: projectIds
          in: query
          type: string
          description: Filter by project IDs
        - name: ignored
          in: query
          type: string
          description: Filter by ignored status
        - name: initiator
          in: query
          type: array
          description: Filter by initiator
        - name: kinds
          in: query
          type: array
          description: Filter by kind
        - name: status
          in: query
          type: array
          description: Filter by status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-emails
      path: /scans/emails
      operations:
      - name: listinboxemails
        method: GET
        description: List inbox emails
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: ids
          in: query
          type: array
          description: Filter by email IDs
        - name: before
          in: query
          type: string
          description: Filter by before date
        - name: after
          in: query
          type: string
          description: Filter by after date
        - name: email
          in: query
          type: string
          required: true
          description: Inbox email address used as `to` filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-emails-id
      path: /scans/emails/{id}
      operations:
      - name: readinboxemail
        method: GET
        description: Read inbox email content
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: The inbox email ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-scanid
      path: /scans/{scanId}
      operations:
      - name: getscan
        method: GET
        description: Get a scan
        inputParameters:
        - name: scanId
          in: path
          type: string
          required: true
          description: The scan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-scanid-cancel
      path: /scans/{scanId}/cancel
      operations:
      - name: cancelscan
        method: PUT
        description: Cancel a scan
        inputParameters:
        - name: scanId
          in: path
          type: string
          required: true
          description: The scan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-scanid-ignore
      path: /scans/{scanId}/ignore
      operations:
      - name: ignorescan
        method: PUT
        description: Ignore a scan
        inputParameters:
        - name: scanId
          in: path
          type: string
          required: true
          description: The scan ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: scans-scanid-targets
      path: /scans/{scanId}/targets
      operations:
      - name: listscantargets
        method: GET
        description: List scan targets and API coverage
        inputParameters:
        - name: scanId
          in: path
          type: string
          required: true
          description: The scan ID
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: types
          in: query
          type: array
          description: Optional filter by target kinds (comma-separated or repeated), e.g. API_ROUTE or GRAPHQL_RESOLVER
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues
      path: /issues
      operations:
      - name: listissues
        method: GET
        description: List issues
        inputParameters:
        - name: cursor
          in: query
          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.
        - name: size
          in: query
          type: integer
          description: The number of items to return per page
        - name: sortType
          in: query
          type: string
          description: The type to sort by
        - name: sortDirection
          in: query
          type: string
          description: The direction to sort by
        - name: profileIds
          in: query
          type: string
          description: Filter by application IDs
        - name: assetIds
          in: query
          type: string
          description: Filter by asset IDs
        - name: domains
          in: query
          type: string
          description: Filter by domain
        - name: ids
          in: query
          type: string
          description: Filter by specific issue IDs
        - name: names
          in: query
          type: string
          description: Filter by issue names
        - name: scanIds
          in: query
          type: string
          description: Filter by scan IDs
        - name: tagIds
          in: query
          type: string
          description: Filter by tag IDs
        - name: search
          in: query
          type: string
          description: Search term to filter issues by name or description
        - name: jiraTicket
          in: query
          type: string
          description: Filter by issues with Jira tickets
        - name: risks
          in: query
          type: array
          description: Filter by risk types
        - name: assetClasses
          in: query
          type: array
          description: Filter by asset classes
        - name: scannerKinds
          in: query
          type: array
          description: Filter by scanner kinds
        - name: severities
          in: query
          type: array
          description: Filter by issue severities
        - name: status
          in: query
          type: array
          description: Filter by issue status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues-funnel
      path: /issues/funnel
      operations:
      - name: getissuefunnel
        method: GET
        description: Get issue funnel
        inputParameters:
        - name: projectIds
          in: query
          type: string
          description: Filter by project IDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues-trends
      path: /issues/trends
      operations:
      - name: getissuetrends
        method: GET
        description: Get issue severity trends
        inputParameters:
        - name: after
          in: query
          type: string
          required: true
          description: Start date (ISO 8601)
        - name: before
          in: query
          type: string
          required: true
          description: End date (ISO 8601)
        - name: interval
          in: query
          type: string
          description: Time bucket interval (e.g. "1 day", "1 week")
        - name: applicationIds
          in: query
          type: string
          description: Filter by application IDs
        - name: projectIds
          in: query
          type: string
          description: Filter by project IDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues-bulk-update
      path: /issues/bulk-update
      operations:
      - name: bulkupdateissues
        method: POST
        description: Bulk update issues
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues-issueid
      path: /issues/{issueId}
      operations:
      - name: getissue
        method: GET
        description: Get an issue
        inputParameters:
        - name: issueId
          in: path
          type: string
          required: true
          description: The issue ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateissue
        method: PUT
        description: Update an issue
        inputParameters:
        - name: issueId
          in: path
          type: string
          required: true
          description: The issue ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: issues-issueid-activities
      path: /issues/{issueId}/activities
      operations:
      - name: listissueactivities
        method: GET
        description: List activities of an issue
        inputParameters:
        - name: issueId
          in: path
          type: string
          required: true
          description: The issue ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createissuecomment
        method: POST
        description: 

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/escape/refs/heads/main/capabilities/escape-capability.yaml