Skip to main content
POST
Create an assessment

Authorizations

Authorization
string
header
required

Bearer token for authentication

Body

application/json

Request to create an assessment

Request to create an assessment

external_id
string

Vulnerability or advisory identifier (e.g. CVE-2024-1234)

products
AssessmentProduct represents a PURL glob entry in the products field · object[]

PURL globs identifying affected products

status
enum<string>
default:ASSESSMENT_STATUS_UNSPECIFIED
Available options:
ASSESSMENT_STATUS_UNSPECIFIED,
ASSESSMENT_STATUS_NOT_AFFECTED,
ASSESSMENT_STATUS_AFFECTED,
ASSESSMENT_STATUS_UNDER_INVESTIGATION,
ASSESSMENT_STATUS_FIXED
justification_code
enum<string>
default:ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED
Available options:
ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED,
ASSESSMENT_JUSTIFICATION_CODE_COMPONENT_NOT_PRESENT,
ASSESSMENT_JUSTIFICATION_CODE_VULNERABLE_CODE_NOT_PRESENT,
ASSESSMENT_JUSTIFICATION_CODE_VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY,
ASSESSMENT_JUSTIFICATION_CODE_VULNERABLE_CODE_NOT_IN_EXECUTE_PATH,
ASSESSMENT_JUSTIFICATION_CODE_INLINE_MITIGATIONS_ALREADY_EXIST
note
string

Free-text note

project_name
string

Project name

project_version_name
string

Project version name (when scoping to a specific version)

Response

A successful response.

Response for Create method

result
AssessmentItem · object

Full representation of a security assessment

Example: