Skip to main content
POST
/
v1
/
assessments
/
list-effective
List effective assessments for lookups
curl --request POST \
  --url https://api.app.chainloop.dev/v1/assessments/list-effective \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_name": "<string>",
  "project_version_name": "<string>",
  "finding_type": "FINDING_TYPE_UNSPECIFIED",
  "lookups": [
    {
      "identity": "identity",
      "external_id": "external_id"
    }
  ]
}
'
{
  "results": [
    {
      "lookup": {
        "identity": "identity",
        "external_id": "external_id"
      },
      "effective_status": "ASSESSMENT_STATUS_UNSPECIFIED",
      "assessments": [
        {
          "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
            },
            "confidence_breakdown": {
              "schema_version": "schema_version",
              "scores": {
                "key": {
                  "reason": "reason",
                  "abstained": true,
                  "value": 5.637376656633329
                }
              },
              "derived": {
                "rollup_active_axes": 7,
                "dominant_low_axis": {
                  "reason": "reason",
                  "axis": "axis",
                  "value": 9.301444243932576
                },
                "rollup": 2.3021358869347655
              }
            },
            "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.962133916683182,
            "id": "id",
            "auto_remediable": true,
            "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
          },
          "auto_remediable": 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",
          "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
            },
            "confidence_breakdown": {
              "schema_version": "schema_version",
              "scores": {
                "key": {
                  "reason": "reason",
                  "abstained": true,
                  "value": 5.637376656633329
                }
              },
              "derived": {
                "rollup_active_axes": 7,
                "dominant_low_axis": {
                  "reason": "reason",
                  "axis": "axis",
                  "value": 9.301444243932576
                },
                "rollup": 2.3021358869347655
              }
            },
            "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.962133916683182,
            "id": "id",
            "auto_remediable": true,
            "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
          },
          "auto_remediable": true,
          "status": "ASSESSMENT_STATUS_UNSPECIFIED"
        }
      ]
    },
    {
      "lookup": {
        "identity": "identity",
        "external_id": "external_id"
      },
      "effective_status": "ASSESSMENT_STATUS_UNSPECIFIED",
      "assessments": [
        {
          "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
            },
            "confidence_breakdown": {
              "schema_version": "schema_version",
              "scores": {
                "key": {
                  "reason": "reason",
                  "abstained": true,
                  "value": 5.637376656633329
                }
              },
              "derived": {
                "rollup_active_axes": 7,
                "dominant_low_axis": {
                  "reason": "reason",
                  "axis": "axis",
                  "value": 9.301444243932576
                },
                "rollup": 2.3021358869347655
              }
            },
            "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.962133916683182,
            "id": "id",
            "auto_remediable": true,
            "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
          },
          "auto_remediable": 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",
          "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
            },
            "confidence_breakdown": {
              "schema_version": "schema_version",
              "scores": {
                "key": {
                  "reason": "reason",
                  "abstained": true,
                  "value": 5.637376656633329
                }
              },
              "derived": {
                "rollup_active_axes": 7,
                "dominant_low_axis": {
                  "reason": "reason",
                  "axis": "axis",
                  "value": 9.301444243932576
                },
                "rollup": 2.3021358869347655
              }
            },
            "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.962133916683182,
            "id": "id",
            "auto_remediable": true,
            "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
          },
          "auto_remediable": 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 look up effective assessments for one or more (external_id, identity) lookups of a given finding type

Request to look up effective assessments for one or more (external_id, identity) lookups of a given finding type

​
project_name
string

Project name

​
project_version_name
string

Project version name (scopes precedence to that version when set)

​
finding_type
enum<string>
default:FINDING_TYPE_UNSPECIFIED

FindingType represents the type of security finding. Lives in shared_messages.proto for the same reason as FindingSeverity: assessment.proto needs it for the ListEffective query tuples without creating an import cycle with finding.proto.

Available options:
FINDING_TYPE_UNSPECIFIED,
FINDING_TYPE_VULNERABILITY
​
lookups
EffectiveAssessmentLookup · object[]

Lookups (1 to 5000 entries)

Response

A successful response.

Response for ListEffective method

​
results
EffectiveAssessmentEntry · object[]

Per-lookup results, index-aligned with the request's lookups