ESescape
Profiles
Beta

Create an AI Pentest profile

Create an AI Pentest profile.

post/profiles/ai-pentest

Request

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

Request body

assetIdsstring[] required

The asset IDs for the pentest profile

namestring required

The name of the pentest profile

descriptionstring

The description of the pentest profile

mode'STANDARD' | 'STRICT'

Strictness mode for the pentest

offLimitsAreasstring

Off-limits areas

artefactIdsstring[] nullable

Uploaded file IDs for the pentest

sourceIdsstring[] nullable

Uploaded source file IDs for the pentest

maxDurationMinutesinteger nullable

Maximum pentest duration in minutes.

rateLimitReqPerSecinteger

The rate limit of the pentest in requests per second

startAtstring date-time

When to run the pentest if not starting immediately

startboolean

Whether to start the scan immediately

Example request

{
  "assetIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "name": "My API Pentest",
  "mode": "STANDARD",
  "maxDurationMinutes": 600,
  "location": {
    "id": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

idstring uuid required

The id of the profile

namestring required

The name of the profile

descriptionstring required

The description of the profile

scannerKindstring required

The scanner kind of the profile

createdAtstring required

The date and time the profile was created

updatedAtstring required

The date and time the profile was updated

cronstring nullable required

Deprecated: use schedule.cron instead.

scheduledForDeletionAtstring nullable required

The date and time the profile is scheduled for deletion

scorenumber nullable required

The score of the profile

coveragenumber nullable required

The coverage of the profile

maxDurationMinutesinteger nullable required

Maximum scan duration in minutes.

schemaAssetIdstring uuid nullable required

Schema asset id derived from the first extraAssets entry with class SCHEMA, a request hint when the link is not yet visible in extraAssets (e.g. immediately after a mutation), or the legacy assetSchemaId while migration/backfill is incomplete.

lastScanIdstring uuid nullable required

The ID of the last scan of the profile

lastSuccessfulScanIdstring uuid nullable required

The ID of the last successful scan of the profile

risksstring[] required

The risks of the profile

Example response

{
  "maxDurationMinutes": 240
}

Changes

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