ESescape
Scans

Get a scan

Get a scan by ID, including its AI pentest results: executive and scope summaries, scanner problems and produced artefacts. Credentials and secrets are redacted.

get/scans/{scanId}

Request

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

Path parameters

scanIdstring required

The scan ID

Example:00000000-0000-0000-0000-000000000000

Response

OK

idstring uuid required

The id of the scan

statusstring required

The status of the scan

createdAtstring required

The date and time the scan was created

updatedAtstring required

The date and time the scan was updated

finishedAtstring nullable required

The date and time the scan was finished

scorenumber nullable required

The score of the scan

coveragenumber nullable required

Aggregate API coverage ratio for this scan (0–1), when the scan has finished with coverage data

durationnumber required

The duration of the scan

progressRationumber required

The progress ratio of the scan

initiatorstring required

The initiator of the scan

kindstring required

The kind of the scan

profileIdstring required

The id of the profile of the scan

organizationIdstring required

The id of the organization of the scan

commitHashstring nullable required
commitBranchstring nullable required
commitAuthorstring nullable required
commitLinkstring nullable required
commitAuthorProfilePictureLinkstring nullable required
ignoredboolean

Whether the scan is ignored. Only returned by the scan detail endpoint.

executiveSummarystring nullable

AI-generated executive summary of the scan. Credentials and secrets are redacted. Only returned by the scan detail endpoint.

scopeSummarystring nullable

AI-generated summary of the scanned scope. Credentials and secrets are redacted. Only returned by the scan detail endpoint.

Changes

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