Public API

API Base URL & OpenAPI Documentation¶

Escape's REST public API can be reached at https://public.escape.tech/v1/

OpenAPI Documentation

The entire OpenAPI Documentation is also available directly on https://public.escape.tech/v1/

Authentication using API Key¶

Pass your API key via the Authorization header. You can find your API key in your Escape settings.

Basic Example¶

export APPLICATION_ID=<YOUR APPLICATION ID>
export API_KEY=<YOUR API KEY>

curl -X POST \
-H "Authorization: Key $API_KEY" \
https://public.escape.tech/applications/$APPLICATION_ID/start-scan