HAhacktron
REST API - Pentests

Start an estimated pentest, spending the confirmed credits (organization admins only)

Changed on
post/pentests/{id}/start

Request

  • Base URL
    https://api.hacktron.ai/v1
  • URL
    https://api.hacktron.ai/v1/pentests/{id}/start
  • Auth
    API key in header X-Api-Key

Path parameters

idstring required

Request body

expected_creditsinteger required

The total the user confirmed: the estimate's total_credits, plus triage_fee_credits when triage is required or opted in

triage_enabledboolean

Opt in to human triage of findings when it is not already required

Response

scan_idstring uuid required

Stable pentest id; task_id changes when it starts

status'pending' | 'running' | 'completed' | 'failed' | 'stopped' | 'cancelled' | 'skipped' | 'pending_verification' | 'pending_triage' | 'draft' | 'estimating' | 'estimated' required
target_urlsstring[] required
custom_contextstring nullable required
application_idstring uuid nullable required
cost_estimation_idstring uuid nullable required
triage_enabledboolean nullable required
credits_usednumber nullable required

Example response

{
  "repos": [
    {
      "include_paths": [
        "services/gateway/**"
      ],
      "exclude_paths": [
        "**/tests/**",
        "vendor/",
        "*.md"
      ],
      "url": "https://github.com/owner/repo"
    }
  ]
}

Changes