Skip to main content
POST
/
v1
/
assessments
Create an assessment
curl --request POST \
  --url https://api.app.chainloop.dev/v1/assessments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "products": [
    {
      "purl_glob": "purl_glob"
    }
  ],
  "status": "ASSESSMENT_STATUS_UNSPECIFIED",
  "justification_code": "ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED",
  "note": "<string>",
  "project_name": "<string>",
  "project_version_name": "<string>"
}
'
{
  "result": {
    "justification_code": "ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED",
    "note": "note",
    "remediation_branch_name": "remediation_branch_name",
    "created_at": "2000-01-23T04:56:07.000Z",
    "external_id": "external_id",
    "remediation_pr_url": "remediation_pr_url",
    "products": [
      {
        "purl_glob": "purl_glob"
      },
      {
        "purl_glob": "purl_glob"
      }
    ],
    "remediation_status": "remediation_status",
    "updated_at": "2000-01-23T04:56:07.000Z",
    "project_id": "project_id",
    "cvss_vector": "cvss_vector",
    "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
    "id": "id",
    "severity": "FINDING_SEVERITY_UNSPECIFIED",
    "effective_reviewed_at": "2000-01-23T04:56:07.000Z",
    "pending_revision": {
      "justification_code": null,
      "note": "note",
      "approval_status": "ASSESSMENT_APPROVAL_STATUS_UNSPECIFIED",
      "reviewed_at": "2000-01-23T04:56:07.000Z",
      "created_at": "2000-01-23T04:56:07.000Z",
      "assessment_id": "assessment_id",
      "project_version_id": "project_version_id",
      "reviewer": {
        "intercom_hash": "intercom_hash",
        "created_at": "2000-01-23T04:56:07.000Z",
        "last_name": "last_name",
        "id": "id",
        "first_name": "first_name",
        "email": "email",
        "instance_admin": true
      },
      "created_by": {
        "api_token": {
          "id": "id"
        },
        "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
        "user": {
          "intercom_hash": "intercom_hash",
          "created_at": "2000-01-23T04:56:07.000Z",
          "last_name": "last_name",
          "id": "id",
          "first_name": "first_name",
          "email": "email",
          "instance_admin": true
        },
        "ai_agent": {
          "name": "name"
        }
      },
      "revision": 1,
      "products": [
        {
          "purl_glob": "purl_glob"
        },
        {
          "purl_glob": "purl_glob"
        }
      ],
      "review_note": "review_note",
      "scope": null,
      "id": "id",
      "status": null
    },
    "remediation_pr_number": 0,
    "project_version_id": "project_version_id",
    "remediation_confidence": 6.027456183070403,
    "created_by": {
      "api_token": {
        "id": "id"
      },
      "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
      "user": {
        "intercom_hash": "intercom_hash",
        "created_at": "2000-01-23T04:56:07.000Z",
        "last_name": "last_name",
        "id": "id",
        "first_name": "first_name",
        "email": "email",
        "instance_admin": true
      },
      "ai_agent": {
        "name": "name"
      }
    },
    "remediation_status_reason": "remediation_status_reason",
    "remediation_updated_at": "2000-01-23T04:56:07.000Z",
    "organization_id": "organization_id",
    "effective_reviewer": {
      "intercom_hash": "intercom_hash",
      "created_at": "2000-01-23T04:56:07.000Z",
      "last_name": "last_name",
      "id": "id",
      "first_name": "first_name",
      "email": "email",
      "instance_admin": true
    },
    "status": "ASSESSMENT_STATUS_UNSPECIFIED"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chainloop.dev/llms.txt

Use this file to discover all available pages before exploring further.

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:
{
  "justification_code": "ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED",
  "note": "note",
  "remediation_branch_name": "remediation_branch_name",
  "created_at": "2000-01-23T04:56:07.000Z",
  "external_id": "external_id",
  "remediation_pr_url": "remediation_pr_url",
  "products": [
    { "purl_glob": "purl_glob" },
    { "purl_glob": "purl_glob" }
  ],
  "remediation_status": "remediation_status",
  "updated_at": "2000-01-23T04:56:07.000Z",
  "project_id": "project_id",
  "cvss_vector": "cvss_vector",
  "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
  "id": "id",
  "severity": "FINDING_SEVERITY_UNSPECIFIED",
  "effective_reviewed_at": "2000-01-23T04:56:07.000Z",
  "pending_revision": {
    "justification_code": null,
    "note": "note",
    "approval_status": "ASSESSMENT_APPROVAL_STATUS_UNSPECIFIED",
    "reviewed_at": "2000-01-23T04:56:07.000Z",
    "created_at": "2000-01-23T04:56:07.000Z",
    "assessment_id": "assessment_id",
    "project_version_id": "project_version_id",
    "reviewer": {
      "intercom_hash": "intercom_hash",
      "created_at": "2000-01-23T04:56:07.000Z",
      "last_name": "last_name",
      "id": "id",
      "first_name": "first_name",
      "email": "email",
      "instance_admin": true
    },
    "created_by": {
      "api_token": { "id": "id" },
      "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
      "user": {
        "intercom_hash": "intercom_hash",
        "created_at": "2000-01-23T04:56:07.000Z",
        "last_name": "last_name",
        "id": "id",
        "first_name": "first_name",
        "email": "email",
        "instance_admin": true
      },
      "ai_agent": { "name": "name" }
    },
    "revision": 1,
    "products": [
      { "purl_glob": "purl_glob" },
      { "purl_glob": "purl_glob" }
    ],
    "review_note": "review_note",
    "scope": null,
    "id": "id",
    "status": null
  },
  "remediation_pr_number": 0,
  "project_version_id": "project_version_id",
  "remediation_confidence": 6.027456183070403,
  "created_by": {
    "api_token": { "id": "id" },
    "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
    "user": {
      "intercom_hash": "intercom_hash",
      "created_at": "2000-01-23T04:56:07.000Z",
      "last_name": "last_name",
      "id": "id",
      "first_name": "first_name",
      "email": "email",
      "instance_admin": true
    },
    "ai_agent": { "name": "name" }
  },
  "remediation_status_reason": "remediation_status_reason",
  "remediation_updated_at": "2000-01-23T04:56:07.000Z",
  "organization_id": "organization_id",
  "effective_reviewer": {
    "intercom_hash": "intercom_hash",
    "created_at": "2000-01-23T04:56:07.000Z",
    "last_name": "last_name",
    "id": "id",
    "first_name": "first_name",
    "email": "email",
    "instance_admin": true
  },
  "status": "ASSESSMENT_STATUS_UNSPECIFIED"
}