Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Escape Profiles API

A Profile is a configuration for the DAST scanning feature.It includes various parameters such as authentication details, environment settings, a schema...Profiles allow you to start scans on an endpoint and will keep track of the scan history.This ensures consistency in repeated scans and helps track changes or improvements over time.See [our documentation](https://docs.escape.tech/documentation/#profile) for more details.

Escape Profiles API is one of 20 APIs that Escape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 15 operations across 13 paths. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://public.escape.tech/v3.

15 operations 13 paths 0 schemas 1 DELETE4 GET7 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://public.escape.tech/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Escape Profiles API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ESCAPE-API-KEY (apiKey). By default, every request must be authenticated.

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 4 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Profiles 15

A Profile is a configuration for the DAST scanning feature. It includes various parameters such as authentication details, environment settings, a schema... Profiles allow you to…

GET
/profiles
List profiles
listProfiles 12 params → 200400
GET
/profiles/problems
List all scan statuses and problems
problems 12 params → 200400
GET
/profiles/{profileId}
Get a profile
getProfile 1 param → 200404
PUT
/profiles/{profileId}
Update a profile
updateProfile 1 param body → 200400404
DELETE
/profiles/{profileId}
Delete a profile
deleteProfile 1 param → 200400404
PUT
/profiles/{profileId}/configuration
Update profile configuration
updateProfileConfiguration 1 param body → 200400404
PUT
/profiles/{profileId}/schemadeprecated
Update profile schema
updateProfileSchema 1 param body → 200400404
POST
/profiles/rest
Create a DAST REST profile
createDastRestProfile body → 200400
POST
/profiles/graphql
Create a DAST GraphQL profile
createDastGraphqlProfile body → 200400
POST
/profiles/webapp
Create a DAST WebApp profile
createDastWebAppProfile body → 200400
POST
/profiles/ai-pentesting/rest
Create an Automated Pentest REST profile
createPentestRestProfile body → 200400
POST
/profiles/ai-pentesting/graphql
Create an Automated Pentest GraphQL profile
createPentestGraphqlProfile body → 200400
POST
/profiles/ai-pentesting/webapp
Create an Automated Pentest WebApp profile
createPentestWebappProfile body → 200400
POST
/authentications
Start an authentication configuration check
startAuthentication body → 200400
GET
/authentications/{authenticationId}
Get authentication configuration check status
getAuthentication 1 param → 200404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

escape-profiles-api-openapi.yml Raw ↑

Other APIs Escape publishes across the network.

Escape Asm API
Escape Assets API
Escape Audit API
Escape Beta API
Escape CustomRules API
Escape Emails API
Escape Events API
Escape Integrations API
Escape Issues API
Escape Jobs API
Escape Locations API
Escape Projects API