> ## 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. # Describe a component > Returns detailed information about a component and all projects/versions where it appears ## OpenAPI ````yaml https://api.app.chainloop.dev/openapi.yaml get /v1/components/{id} openapi: 3.0.1 info: contact: email: support@chainloop.dev name: Chainloop Support url: https://chainloop.dev termsOfService: https://chainloop.dev/terms title: Chainloop Platform API version: '1.0' servers: - url: https://api.app.chainloop.dev/ security: - bearerToken: [] tags: - description: AI-powered agent operations name: AgentsService - name: ArtifactService - name: AssessmentService - description: Service for polling the status of asynchronous operations name: AsyncOperationsService - name: AttestationsService - name: PolicyService - name: ComplianceService - name: ComponentService - name: EnvironmentsService - name: EvidenceService - name: FindingService - name: LogicalEnvironmentsService - name: ProductsService - name: ProjectsService - name: UserService externalDocs: description: Chainloop Official Documentation url: https://docs.chainloop.dev paths: /v1/components/{id}: get: tags: - ComponentService summary: Describe a component description: >- Returns detailed information about a component and all projects/versions where it appears operationId: ComponentService_Describe parameters: - description: UUID of the component to describe in: path name: id required: true schema: type: string - description: |- ProjectName optionally scopes results to this project Project name to scope component details to in: query name: project_name schema: type: string - description: >- Project version name to scope component details to. Requires project_name. in: query name: project_version_name schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/v1ComponentServiceDescribeResponse' description: A successful response. '400': content: application/json: schema: $ref: '#/components/schemas/v1BadRequestResponse' description: Bad Request - The request was invalid or cannot be served. '401': content: application/json: schema: $ref: '#/components/schemas/v1UnauthorizedResponse' description: Unauthorized - Authentication is required. '403': content: application/json: schema: $ref: '#/components/schemas/v1PermissionDeniedResponse' description: Forbidden - You do not have permission to access this resource. '500': content: application/json: schema: $ref: '#/components/schemas/v1InternalServerErrorResponse' description: Internal Server Error - An unexpected error occurred on the server. default: content: application/json: schema: $ref: '#/components/schemas/rpcStatus' description: An unexpected error response. components: schemas: v1ComponentServiceDescribeResponse: description: Response containing component details and usage information example: 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 properties: component: $ref: '#/components/schemas/v1ComponentItem' projects: description: List of projects where this component appears items: $ref: '#/components/schemas/v1ComponentProject' title: Projects is the list of projects where this component is used type: array artifacts: description: >- Artifacts associated with this component (e.g., container images that this component represents). Only populated for main components. items: $ref: '#/components/schemas/v1ComponentArtifact' title: >- Artifacts is the list of artifacts associated with this component (e.g., container images that this component represents) type: array title: ComponentServiceDescribeResponse type: object v1BadRequestResponse: description: Response for bad request example: code: 0 details: - details - details message: message properties: code: default: 3 description: >- The error code indicating the type of error. It's fixed to 3, which is the code for INVALID_ARGUMENT. format: int32 type: integer message: description: A human-readable message providing more details about the error. type: string details: description: Additional details about the error. items: type: string type: array required: - code - message title: BadRequestResponse type: object v1UnauthorizedResponse: description: Response for unauthorized access example: code: 6 details: - details - details message: message properties: code: default: 16 description: >- The error code indicating the type of error. It's fixed to 16, which is the code for UNAUTHENTICATED. format: int32 type: integer message: description: A human-readable message providing more details about the error. type: string details: description: Additional details about the error. items: type: string type: array required: - code - message title: UnauthorizedResponse type: object v1PermissionDeniedResponse: description: Response for permission denied example: code: 1 details: - details - details message: message properties: code: default: 7 description: >- The error code indicating the type of error. It's fixed to 7, which is the code for PERMISSION_DENIED. format: int32 type: integer message: description: A human-readable message providing more details about the error. type: string details: description: Additional details about the error. items: type: string type: array required: - code - message title: PermissionDeniedResponse type: object v1InternalServerErrorResponse: description: Response for internal server error example: code: 5 details: - details - details message: message properties: code: default: 13 description: >- The error code indicating the type of error. It's fixed to 13, which is the code for INTERNAL_ERROR. format: int32 type: integer message: description: A human-readable message providing more details about the error. type: string details: description: Additional details about the error. items: type: string type: array required: - code - message title: InternalServerErrorResponse type: object rpcStatus: example: code: 5 details: - '@type': '@type' - '@type': '@type' message: message properties: code: format: int32 type: integer message: type: string details: items: $ref: '#/components/schemas/protobufAny' type: array type: object v1ComponentItem: description: 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 properties: id: description: Unique identifier of the component title: ID is the unique identifier of the component type: string purl: description: Package URL of the component title: PURL is the Package URL of the component type: string name: description: Name of the component title: Name is the name of the component type: string version: description: Version of the component title: Version is the version of the component type: string component_type: description: Type of the component (e.g., library, application) title: >- ComponentType is the type of the component (e.g., library, application) type: string cpe: description: CPE identifier of the component title: CPE is the CPE identifier of the component type: string created_at: description: Timestamp when the component was created format: date-time title: CreatedAt is the timestamp when the component was created type: string auto_generated_purl: description: >- Indicates if the PURL was automatically generated by Chainloop (vs. provided in SBOM) title: >- AutoGeneratedPurl indicates if the PURL was automatically generated by Chainloop type: boolean parents: description: >- Parent components (e.g., container images) that include this component as a dependency. Empty for main components. Only populated in Describe responses. items: $ref: '#/components/schemas/v1ComponentItem' title: >- Parents is the list of parent components (main components) that include this component as a dependency type: array children: description: >- Child components (dependencies) of this component. Empty for leaf components. Only populated in Describe responses. items: $ref: '#/components/schemas/v1ComponentItem' title: >- Children is the list of child components (dependencies) of this component type: array findings_summary: $ref: '#/components/schemas/v1ComponentFindingsSummary' title: ComponentItem type: object v1ComponentProject: description: Information about component usage within a project example: 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 properties: project_id: description: UUID of the project title: ProjectID is the unique identifier of the project type: string project_name: description: Name of the project title: ProjectName is the name of the project type: string versions: description: List of project versions where this component appears items: $ref: '#/components/schemas/v1ComponentProjectVersion' title: >- Versions is the list of project versions where this component is used type: array title: ComponentProject type: object v1ComponentArtifact: description: An artifact associated with a component example: kind: kind name: name digest: digest version: version properties: kind: description: Type of artifact (e.g., CONTAINER_IMAGE, HELM_CHART) title: Kind is the type of artifact (e.g., CONTAINER_IMAGE, HELM_CHART) type: string name: description: Name of the artifact (e.g., container image name) title: Name is the name of the artifact (e.g., container image name) type: string version: description: Version of the artifact (e.g., container image tag) title: Version is the version of the artifact (e.g., container image tag) type: string digest: description: Content digest of the artifact title: Digest is the content digest of the artifact type: string title: ComponentArtifact type: object protobufAny: additionalProperties: type: object example: '@type': '@type' properties: '@type': type: string type: object v1ComponentFindingsSummary: description: Per-severity active finding counts for a software component example: total: 0 high: 1 critical: 6 low: 5 medium: 5 unknown: 2 properties: total: description: Total active findings linked to the component format: int32 type: integer critical: description: Critical-severity active findings format: int32 title: Critical-severity active findings type: integer high: description: High-severity active findings format: int32 title: High-severity active findings type: integer medium: description: Medium-severity active findings format: int32 title: Medium-severity active findings type: integer low: description: Low-severity active findings format: int32 title: Low-severity active findings type: integer unknown: description: Findings with unknown severity format: int32 title: Findings with severity unknown / unclassified type: integer title: ComponentFindingsSummary type: object v1ComponentProjectVersion: description: Information about component usage within a project version example: project_version_name: project_version_name sboms: - digest: digest - digest: digest project_version_id: project_version_id properties: project_version_id: description: UUID of the project version title: ProjectVersionID is the unique identifier of the project version type: string project_version_name: description: Name of the project version title: ProjectVersionName is the name of the project version type: string sboms: description: List of SBOMs containing this component in this version items: $ref: '#/components/schemas/v1ComponentSbom' title: Sboms contains information about the SBOMs containing this component type: array title: ComponentProjectVersion type: object v1ComponentSbom: description: Information about an SBOM containing a component example: digest: digest properties: digest: description: Content digest of the SBOM title: Digest is the content digest of the SBOM type: string title: ComponentSbom type: object securitySchemes: bearerToken: description: Bearer token for authentication type: http scheme: bearer bearerFormat: JWT ````