Skip to main content
GET
Describe a component

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:
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.