Get pentest assessment

Get detailed information about a specific pentest assessment including status, progress, and issue count

get/pentests/assessments/{assessment_id}/detail

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/pentests/assessments/{assessment_id}/detail
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: pentests:read

Path parameters

assessment_idstring uuid required

The unique UUID of the pentest assessment

Response

Assessment details are returned

pentest_status'draft' | 'pending' | 'running' | 'paused' | 'completed' | 'cancelled' | 'failed'

The current status of the pentest assessment

pentest_status_reasonstring

The reason for the current status (Can be empty)

issue_countinteger

The number of open issues found during the assessment

Example response

{
  "pentest_status": "running",
  "pentest_status_reason": "",
  "issue_count": 0
}

Changes

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