Create pentest draft

post

https://app.aikido.dev/api/public/v1/pentests/assessments/createDraft

Create a new draft pentest assessment. The project will be created if it doesn't exist. You can either provide existing repository IDs or create a custom repository from a download URL.

Body Params

The parameters needed to create a new draft pentest assessment

project_name

string

required

The name of the pentest project. If the project doesn't exist, it will be created.

domains

array of strings

required

length ≥ 1

An array of domain URLs to include in the pentest assessment. Cannot be empty.

domains*

custom_headers

object

A map of custom headers to include in the assessment. Must be of format {header_name: header_value, ...}

repository_ids

array of integers

An array of existing code repository IDs to include in the assessment. Required if 'repository_download_url' and 'repository_name' are not provided.

repository_ids

repository_download_url

string

URL to download a custom code repository. Must be provided together with 'repository_name'. If provided, 'repository_ids' should not be provided.

repository_name

string

Name for the custom code repository. Must be provided together with 'repository_download_url'. If provided, 'repository_ids' should not be provided.

additional_notes

string

length ≤ 2000

Optional notes for the assessment, such as test accounts or behavior the code and documentation do not cover. Shown as additional notes in the draft.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The draft assessment has been successfully created

400One or more of the provided fields are invalid or missing.