Skip to main content
POST
Price a draft pentest; read it at GET /cost-estimations/{cost_estimation_id}
Starts a cost estimation for the draft and returns its cost_estimation_id. Poll Get cost estimation until its status is completed or partial.
Scope required: write. Role: member or above.
When you start the pentest, confirm the estimate’s total_credits. Add triage_fee_credits if triage_required is true or you opt in to triage. Estimate again whenever you change the draft.

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Response

200 - application/json
scan_id
string<uuid>
required

Stable pentest id; task_id changes when it starts

status
enum<string>
required
Available options:
pending,
running,
completed,
failed,
stopped,
cancelled,
skipped,
pending_verification,
pending_triage,
draft,
estimating,
estimated
repos
object[]
required
target_urls
string[]
required
login_targets
object[]
required
custom_context
string | null
required
application_id
string<uuid> | null
required
cost_estimation_id
string<uuid> | null
required
triage_enabled
boolean | null
required
credits_used
number | null
required