List pentest assessments

Returns all pentest assessments in your account, newest first. Draft assessments are not included.

get/pentests/assessments

Request

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

Query parameters

pageinteger

Pagination parameter, starts at 0.

per_pageinteger

Amount of items returned

Response

A list of assessments

idstring uuid

The unique UUID of the assessment. Can be used with the assessment detail endpoint and as filter_assessment_id when exporting issues.

namestring

The name of the assessment

status'pending' | 'running' | 'paused' | 'completed' | 'cancelled' | 'failed'

The current status of the assessment

created_atinteger

A unix timestamp (in seconds) indicating when the assessment was created

Example response

[
  {
    "id": "f19e449d-2bf0-8d37-ab9a-3bcbc748157d",
    "name": "Production web app pentest",
    "status": "completed",
    "created_at": 1760000000
  }
]

Changes

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