ESescape
Profiles

Start an authentication configuration check

Validates authentication credentials without running a full scan. Provide authentication directly, or pass a profileId to reuse its saved authentication (optionally overriding it). Poll GET /authentications/{id} until status is FINISHED, FAILED, or CANCELED.

post/authentications

Request

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

Request body

profileIdstring uuid

Profile whose saved configuration is used as the baseline. When omitted, authentication must be provided.

authenticationobject

Authentication object to validate. When profileId is also set, this replaces the profile saved authentication.

proxyIdstring uuid nullable

Force a specific Escape or private location (proxy) for this check

defaultProxyType'ESCAPE' | 'PRIVATE'

When proxyId is omitted, restrict to Escape-managed locations or private locations

Response

OK

idstring uuid required

Identifier for this check; use it when polling for status

status'CANCELED' | 'FAILED' | 'FINISHED' | 'RUNNING' | 'STARTING' required

Initial lifecycle state (typically STARTING right after creation)

Changes

No recorded changes to this operation across all 1 revision of this API.