Skip to main content
GET
/
v1
/
components
/
{id}
Describe a component
curl --request GET \
  --url https://api.app.chainloop.dev/v1/components/{id} \
  --header 'Authorization: Bearer <token>'
{
  "component": {
    "component_type": "component_type",
    "children": [
      null,
      null
    ],
    "name": "name",
    "cpe": "cpe",
    "created_at": "2000-01-23T04:56:07.000Z",
    "id": "id",
    "purl": "purl",
    "findings_summary": {
      "total": 0,
      "high": 1,
      "critical": 6,
      "low": 5,
      "medium": 5,
      "unknown": 2
    },
    "version": "version",
    "auto_generated_purl": true,
    "parents": [
      null,
      null
    ]
  },
  "projects": [
    {
      "project_id": "project_id",
      "versions": [
        {
          "project_version_name": "project_version_name",
          "sboms": [
            {
              "digest": "digest"
            },
            {
              "digest": "digest"
            }
          ],
          "project_version_id": "project_version_id"
        },
        {
          "project_version_name": "project_version_name",
          "sboms": [
            {
              "digest": "digest"
            },
            {
              "digest": "digest"
            }
          ],
          "project_version_id": "project_version_id"
        }
      ],
      "project_name": "project_name"
    },
    {
      "project_id": "project_id",
      "versions": [
        {
          "project_version_name": "project_version_name",
          "sboms": [
            {
              "digest": "digest"
            },
            {
              "digest": "digest"
            }
          ],
          "project_version_id": "project_version_id"
        },
        {
          "project_version_name": "project_version_name",
          "sboms": [
            {
              "digest": "digest"
            },
            {
              "digest": "digest"
            }
          ],
          "project_version_id": "project_version_id"
        }
      ],
      "project_name": "project_name"
    }
  ],
  "artifacts": [
    {
      "kind": "kind",
      "name": "name",
      "digest": "digest",
      "version": "version"
    },
    {
      "kind": "kind",
      "name": "name",
      "digest": "digest",
      "version": "version"
    }
  ]
}

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

Path Parameters

​
id
string
required

UUID of the component to describe

Query Parameters

​
project_name
string

ProjectName optionally scopes results to this project

Project name to scope component details to

​
project_version_name
string

Project version name to scope component details to. Requires project_name.

Response

A successful response.

Response containing component details and usage information

​
component
ComponentItem · object

It represents an item in the list of components

Example:
{
  "component_type": "component_type",
  "children": [null, null],
  "name": "name",
  "cpe": "cpe",
  "created_at": "2000-01-23T04:56:07.000Z",
  "id": "id",
  "purl": "purl",
  "findings_summary": {
    "total": 0,
    "high": 1,
    "critical": 6,
    "low": 5,
    "medium": 5,
    "unknown": 2
  },
  "version": "version",
  "auto_generated_purl": true,
  "parents": [null, null]
}
​
projects
ComponentProject · object[]

List of projects where this component appears

​
artifacts
ComponentArtifact · object[]

Artifacts associated with this component (e.g., container images that this component represents). Only populated for main components.