List assessments

List assessments

curl --request GET \
  --url https://api.app.chainloop.dev/v1/assessments \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.app.chainloop.dev/v1/assessments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.app.chainloop.dev/v1/assessments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.chainloop.dev/v1/assessments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.app.chainloop.dev/v1/assessments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.app.chainloop.dev/v1/assessments")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.app.chainloop.dev/v1/assessments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "pagination": {
    "total_count": 1,
    "page": 4,
    "total_pages": 1,
    "page_size": 7
  },
  "results": [
    {
      "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",
      "fixable_feasibility": 2.027123023002322,
      "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",
      "remediation_pr_state": "remediation_pr_state",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "fixable_status": null,
      "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",
        "fixable_summary": "fixable_summary",
        "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
        },
        "fixable_feasibility": 5.962133916683182,
        "confidence_breakdown": {
          "schema_version": "schema_version",
          "scores": {
            "key": {
              "reason": "reason",
              "abstained": true,
              "value": 2.3021358869347655
            }
          },
          "derived": {
            "rollup_active_axes": 9,
            "dominant_low_axis": {
              "reason": "reason",
              "axis": "axis",
              "value": 3.616076749251911
            },
            "rollup": 7.061401241503109
          }
        },
        "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,
        "confidence_score": 5.637376656633329,
        "id": "id",
        "fixable_status": "FIXABLE_STATUS_UNSPECIFIED",
        "status": null
      },
      "remediation_pr_number": 0,
      "fixable_summary": "fixable_summary",
      "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"
    },
    {
      "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",
      "fixable_feasibility": 2.027123023002322,
      "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",
      "remediation_pr_state": "remediation_pr_state",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "fixable_status": null,
      "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",
        "fixable_summary": "fixable_summary",
        "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
        },
        "fixable_feasibility": 5.962133916683182,
        "confidence_breakdown": {
          "schema_version": "schema_version",
          "scores": {
            "key": {
              "reason": "reason",
              "abstained": true,
              "value": 2.3021358869347655
            }
          },
          "derived": {
            "rollup_active_axes": 9,
            "dominant_low_axis": {
              "reason": "reason",
              "axis": "axis",
              "value": 3.616076749251911
            },
            "rollup": 7.061401241503109
          }
        },
        "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,
        "confidence_score": 5.637376656633329,
        "id": "id",
        "fixable_status": "FIXABLE_STATUS_UNSPECIFIED",
        "status": null
      },
      "remediation_pr_number": 0,
      "fixable_summary": "fixable_summary",
      "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"
    }
  ]
}

{
  "code": 0,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 6,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 1,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 5,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 5,
  "details": [
    {
      "@type": "@type"
    },
    {
      "@type": "@type"
    }
  ],
  "message": "message"
}

GET

assessments

List assessments

curl --request GET \
  --url https://api.app.chainloop.dev/v1/assessments \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.app.chainloop.dev/v1/assessments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.app.chainloop.dev/v1/assessments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.chainloop.dev/v1/assessments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.app.chainloop.dev/v1/assessments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.app.chainloop.dev/v1/assessments")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.app.chainloop.dev/v1/assessments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "pagination": {
    "total_count": 1,
    "page": 4,
    "total_pages": 1,
    "page_size": 7
  },
  "results": [
    {
      "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",
      "fixable_feasibility": 2.027123023002322,
      "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",
      "remediation_pr_state": "remediation_pr_state",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "fixable_status": null,
      "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",
        "fixable_summary": "fixable_summary",
        "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
        },
        "fixable_feasibility": 5.962133916683182,
        "confidence_breakdown": {
          "schema_version": "schema_version",
          "scores": {
            "key": {
              "reason": "reason",
              "abstained": true,
              "value": 2.3021358869347655
            }
          },
          "derived": {
            "rollup_active_axes": 9,
            "dominant_low_axis": {
              "reason": "reason",
              "axis": "axis",
              "value": 3.616076749251911
            },
            "rollup": 7.061401241503109
          }
        },
        "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,
        "confidence_score": 5.637376656633329,
        "id": "id",
        "fixable_status": "FIXABLE_STATUS_UNSPECIFIED",
        "status": null
      },
      "remediation_pr_number": 0,
      "fixable_summary": "fixable_summary",
      "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"
    },
    {
      "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",
      "fixable_feasibility": 2.027123023002322,
      "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",
      "remediation_pr_state": "remediation_pr_state",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "fixable_status": null,
      "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",
        "fixable_summary": "fixable_summary",
        "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
        },
        "fixable_feasibility": 5.962133916683182,
        "confidence_breakdown": {
          "schema_version": "schema_version",
          "scores": {
            "key": {
              "reason": "reason",
              "abstained": true,
              "value": 2.3021358869347655
            }
          },
          "derived": {
            "rollup_active_axes": 9,
            "dominant_low_axis": {
              "reason": "reason",
              "axis": "axis",
              "value": 3.616076749251911
            },
            "rollup": 7.061401241503109
          }
        },
        "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,
        "confidence_score": 5.637376656633329,
        "id": "id",
        "fixable_status": "FIXABLE_STATUS_UNSPECIFIED",
        "status": null
      },
      "remediation_pr_number": 0,
      "fixable_summary": "fixable_summary",
      "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"
    }
  ]
}

{
  "code": 0,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 6,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 1,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 5,
  "details": [
    "details",
    "details"
  ],
  "message": "message"
}

{
  "code": 5,
  "details": [
    {
      "@type": "@type"
    },
    {
      "@type": "@type"
    }
  ],
  "message": "message"
}

Authorizations

Authorization

string

header

required

Bearer token for authentication

Query Parameters

scope

enum<string>

default:ASSESSMENT_SCOPE_UNSPECIFIED

Filter by scope

Available options:

ASSESSMENT_SCOPE_UNSPECIFIED,

ASSESSMENT_SCOPE_PROJECT,

ASSESSMENT_SCOPE_PROJECT_VERSION

external_id

string

Filter by external ID (e.g. CVE identifier)

project_name

string

Filter by project name

pagination.page

integer<int32>

The (zero-based) offset of the first item returned in the collection.

pagination.page_size

integer<int32>

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

project_version_name

string

Filter by project version name

finding_id

string

Filter by finding ID to list assessments linked to a specific finding

Filter by finding ID

has_findings

boolean

Filter by whether the assessment has any linked findings

Filter by presence of linked findings. True = only with findings, false = only without

has_pending_revision

boolean

Filter by whether the assessment has a pending revision awaiting review

Filter by presence of a pending revision. True = only with a pending review, false = only without

relevant_to_project_version

boolean

When true, only return assessments relevant to the target project version (version-scoped, or project-scoped with findings linked on that version). Applied only when project_version_name is set; otherwise ignored.

statuses

enum<string>[]

Filter by one or more statuses (match any). Empty means no status filter.

Available options:

ASSESSMENT_STATUS_UNSPECIFIED,

ASSESSMENT_STATUS_NOT_AFFECTED,

ASSESSMENT_STATUS_AFFECTED,

ASSESSMENT_STATUS_UNDER_INVESTIGATION,

ASSESSMENT_STATUS_FIXED

Response

A successful response.

Response for List method

results

AssessmentItem · object[]

Show child attributes

pagination

OffsetPaginationResponse is used to return the pagination information · object

Show child attributes

Example:

{
  "total_count": 1,
  "page": 4,
  "total_pages": 1,
  "page_size": 7
}

Describe an artifact Create an assessment

Chainloop Controlplane Endpoints

Platform Endpoints

Authorizations

Query Parameters

Response