Skip to main content
POST
Create an assessment (V1)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name of the assessment

Required string length: 5 - 100
Example:

"Customer portal"

category
enum<string>
required

Type of the assessment. API assessments need API testing enabled for the organization.

Available options:
Web Application,
Host,
API
assessment_group_id
integer
required

ID of the assessment group to create the assessment in

Example:

123

assets
object[]
required

Assets to test

Minimum array length: 1
description
string

Description of the assessment

authentication_self_registration_enabled
boolean
default:false

Whether researchers may register their own accounts for authenticated testing

tag_names
string[]

Names of the tags to put on the assessment

Example:

Response

The created assessment

id
string
required

ID of the assessment

Example:

"foobar-123"

name
string
required
Example:

"Customer portal"

codename
string
required
Example:

"ACMEALPHA"

category
string
required

Type of the assessment

Example:

"Web Application"

active
boolean
required

Whether the assessment is open for testing

created_at
string<date-time>
required
tag_ids
integer[]
required
authentication_self_registration_enabled
boolean
required

Whether researchers may register their own accounts for authenticated testing

description
string | null
details
string | null
rules
string | null

Rules of engagement of the assessment

updates
object[]

Updates posted to the researchers