Artifacts associated with this component (e.g., container images that this component represents). Only populated for main components.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chainloop Documentation","description":"Chainloop secures your software supply chain by automating compliance, ensuring traceability, and enhancing collaboration across Dev, Sec, and Ops. With real-time visibility, a centralized evidence store, and a curated policy library, it accelerates delivery and helps teams ship secure, compliant software faster.","colors":{"primary":"#2D1BD2","light":"#FF5C4D","dark":"#9F8951"},"logo":{"light":"https://mintcdn.com/chainloop/piBVJM34fSFTGk0R/images/logo/light.svg?fit=max\u0026auto=format\u0026n=piBVJM34fSFTGk0R\u0026q=85\u0026s=4bc355683f7e78c629ece2e28db71dff","dark":"https://mintcdn.com/chainloop/xJ5hNAgMrS6U1u_m/images/logo/dark.png?fit=max\u0026auto=format\u0026n=xJ5hNAgMrS6U1u_m\u0026q=85\u0026s=9e6be3ff192adebcb1f8fda40d07f9e4","href":"https://chainloop.dev/"},"favicon":"https://mintcdn.com/chainloop/yJa2Iopv98OPg1FZ/images/favicon/favicon-32x32.png?fit=max\u0026auto=format\u0026n=yJa2Iopv98OPg1FZ\u0026q=85\u0026s=1a0b74dcba7ec787f8ed05421f617d11","navbar":{"primary":{"type":"button","label":"Get a demo","href":"https://chainloop.dev/book-a-demo"}},"footer":{"socials":{"slack":"https://join.slack.com/t/chainloop-community/shared_invite/zt-2k34dvx3r-u85uGP_KiLC6ic5Wy4aRnQ","github":"https://github.com/chainloop-dev","x":"https://x.com/chainloop_dev","linkedin":"https://www.linkedin.com/company/chainloop-dev","youtube":"https://www.youtube.com/@chainloop-dev"}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"integrations":{"intercom":{"appId":"t3644vit"},"posthog":{"apiKey":"phc_rCvU7fL4Ndr4GpzH54RNdyNUWNgTpuHX7ApDxFW6G9FS","apiHost":"https://t.chainloop.dev"},"cookies":{"key":"chainloop_analytics_consent","value":"granted"}},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://chainloop.dev/"},{"anchor":"Blog","icon":"newspaper","href":"https://chainloop.dev/blog"},{"anchor":"Get Help","icon":"headset","href":"https://help.chainloop.dev"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chainloop","hasAudioNarration":false,"actualSubdomain":"chainloop","customDomains":["docs.chainloop.dev"],"gitSource":{"type":"github","owner":"chainloop-dev","repo":"platform-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada28dc2cd1c8b6f0158d47","collectionId":"a412b18d-c284-41ca-ba95-fecbfa0ac024","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada28dc2cd1c8b6f0158d47"},"feedback":{"thumbs":false,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada28dc2cd1c8b6f0158d47","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Documentation","count":90},{"language":"default","tag":"Reference","count":65},{"language":"default","tag":"API Reference","count":62},{"language":"default","tag":"Platform Endpoints","count":59},{"language":"default","tag":"Guides","count":40},{"language":"default","tag":"Concepts","count":23},{"language":"default","tag":"References","count":17},{"language":"default","tag":"Deployment","count":15},{"language":"default","tag":"Configuration Guides","count":12},{"language":"default","tag":"AssessmentService","count":11}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/componentservice/describe-a-component","slug":"/api-reference/componentservice/describe-a-component","pageMetadata":{"title":"Describe a component","description":"Returns detailed information about a component and all projects/versions where it appears","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/components/{id}","href":"/api-reference/componentservice/describe-a-component","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns detailed information about a component and all projects/versions where it appears\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Describe a component","description":"Returns detailed information about a component and all projects/versions where it appears","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/components/{id}","href":"/api-reference/componentservice/describe-a-component","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/chainloop/253f77efa74d603b/cioanalytics.js","/_mintlify/custom/chainloop/86afb8ad5e3e2752/banner-expiry.js","/_mintlify/custom/chainloop/6873c2c42265ece7/hubspot.js","/_mintlify/custom/chainloop/f6648ff7bc1812af/termly.js"],"openApiReferenceData":{"operation":{"description":"Returns detailed information about a component and all projects/versions where it appears","operationId":"ComponentService_Describe","parameters":["37b61e25-43a6-495e-a2f7-a677c24a1cfb","b4827a83-39bc-41b0-870e-31e4f9446d85","d47f0c7d-31c5-4f75-8432-039ea05239a7"],"responses":{"200":"a27edf2a-3986-426a-ba62-b3e58ebf5ed9","400":"f3a088e9-0d89-41b1-afce-fa1603c2da5c","401":"b5cce41f-342e-47df-9144-094d556716e3","403":"4ea6cd43-c2c1-439f-a24f-9e7c46b9330e","500":"156ca72c-0726-4ad9-a2fd-d13ae11b7705","default":"d394f853-0118-4ee4-ad68-66fb5d171fbd"},"summary":"Describe a component","tags":["ComponentService"],"method":"get","type":"path","servers":["27e6ed67-0727-4ed5-954e-6ef60eb45150"],"security":["d219d3b3-f34a-4604-bff4-947dbe85e4f8"],"path":"/v1/components/{id}","baseUrlOptions":["https://api.app.chainloop.dev/"],"title":"Describe a component","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"37b61e25-43a6-495e-a2f7-a677c24a1cfb":{"description":"UUID of the component to describe","in":"path","name":"id","required":true,"schema":{"type":"string","isRequired":true,"description":"UUID of the component to describe","uniqueKey":"","typeLabel":"string"}},"b4827a83-39bc-41b0-870e-31e4f9446d85":{"description":"ProjectName optionally scopes results to this project\n\nProject name to scope component details to","in":"query","name":"project_name","schema":{"type":"string","description":"ProjectName optionally scopes results to this project\n\nProject name to scope component details to","uniqueKey":"","typeLabel":"string"}},"d47f0c7d-31c5-4f75-8432-039ea05239a7":{"description":"Project version name to scope component details to. Requires project_name.","in":"query","name":"project_version_name","schema":{"type":"string","description":"Project version name to scope component details to. Requires project_name.","uniqueKey":"","typeLabel":"string"}}},"responses":{"a27edf2a-3986-426a-ba62-b3e58ebf5ed9":{"content":{"application/json":{"schema":{"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":{"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","uniqueKey":"component.id","typeLabel":"string"},"purl":{"description":"Package URL of the component","title":"PURL is the Package URL of the component","type":"string","uniqueKey":"component.purl","typeLabel":"string"},"name":{"description":"Name of the component","title":"Name is the name of the component","type":"string","uniqueKey":"component.name","typeLabel":"string"},"version":{"description":"Version of the component","title":"Version is the version of the component","type":"string","uniqueKey":"component.version","typeLabel":"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","uniqueKey":"component.component_type","typeLabel":"string"},"cpe":{"description":"CPE identifier of the component","title":"CPE is the CPE identifier of the component","type":"string","uniqueKey":"component.cpe","typeLabel":"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","uniqueKey":"component.created_at","typeLabel":"string\u003cdate-time>"},"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","uniqueKey":"component.auto_generated_purl","typeLabel":"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":{"$circularRef":"640ab205-656b-41f2-8bc6-f6070b1486fb"},"title":"Parents is the list of parent components (main components) that include this component as a dependency","type":"array","uniqueKey":"component.parents","typeLabel":"Parents is the list of parent components (main components) that include this component as a dependency · array"},"children":{"description":"Child components (dependencies) of this component. Empty for leaf components. Only populated in Describe responses.","items":{"$circularRef":"640ab205-656b-41f2-8bc6-f6070b1486fb"},"title":"Children is the list of child components (dependencies) of this component","type":"array","uniqueKey":"component.children","typeLabel":"Children is the list of child components (dependencies) of this component · array"},"findings_summary":{"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","uniqueKey":"component.findings_summary.total","typeLabel":"integer\u003cint32>"},"critical":{"description":"Critical-severity active findings","format":"int32","title":"Critical-severity active findings","type":"integer","uniqueKey":"component.findings_summary.critical","typeLabel":"integer\u003cint32>"},"high":{"description":"High-severity active findings","format":"int32","title":"High-severity active findings","type":"integer","uniqueKey":"component.findings_summary.high","typeLabel":"integer\u003cint32>"},"medium":{"description":"Medium-severity active findings","format":"int32","title":"Medium-severity active findings","type":"integer","uniqueKey":"component.findings_summary.medium","typeLabel":"integer\u003cint32>"},"low":{"description":"Low-severity active findings","format":"int32","title":"Low-severity active findings","type":"integer","uniqueKey":"component.findings_summary.low","typeLabel":"integer\u003cint32>"},"unknown":{"description":"Findings with unknown severity","format":"int32","title":"Findings with severity unknown / unclassified","type":"integer","uniqueKey":"component.findings_summary.unknown","typeLabel":"integer\u003cint32>"}},"title":"ComponentFindingsSummary","type":"object","uniqueKey":"component.findings_summary","typeLabel":"ComponentFindingsSummary · object"}},"title":"ComponentItem","type":"object","uniqueKey":"component","typeLabel":"ComponentItem · object"},"projects":{"description":"List of projects where this component appears","items":{"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","uniqueKey":"projects.items.[INDEX].project_id","typeLabel":"string"},"project_name":{"description":"Name of the project","title":"ProjectName is the name of the project","type":"string","uniqueKey":"projects.items.[INDEX].project_name","typeLabel":"string"},"versions":{"description":"List of project versions where this component appears","items":{"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","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX].project_version_id","typeLabel":"string"},"project_version_name":{"description":"Name of the project version","title":"ProjectVersionName is the name of the project version","type":"string","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX].project_version_name","typeLabel":"string"},"sboms":{"description":"List of SBOMs containing this component in this version","items":{"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","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX].sboms.items.[INDEX].digest","typeLabel":"string"}},"title":"ComponentSbom","type":"object","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX].sboms.items.[INDEX]","typeLabel":"ComponentSbom · object"},"title":"Sboms contains information about the SBOMs containing this component","type":"array","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX].sboms","typeLabel":"ComponentSbom · object[]"}},"title":"ComponentProjectVersion","type":"object","uniqueKey":"projects.items.[INDEX].versions.items.[INDEX]","typeLabel":"ComponentProjectVersion · object"},"title":"Versions is the list of project versions where this component is used","type":"array","uniqueKey":"projects.items.[INDEX].versions","typeLabel":"ComponentProjectVersion · object[]"}},"title":"ComponentProject","type":"object","uniqueKey":"projects.items.[INDEX]","typeLabel":"ComponentProject · object"},"title":"Projects is the list of projects where this component is used","type":"array","uniqueKey":"projects","typeLabel":"ComponentProject · object[]"},"artifacts":{"description":"Artifacts associated with this component (e.g., container images that this component represents). Only populated for main components.","items":{"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","uniqueKey":"artifacts.items.[INDEX].kind","typeLabel":"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","uniqueKey":"artifacts.items.[INDEX].name","typeLabel":"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","uniqueKey":"artifacts.items.[INDEX].version","typeLabel":"string"},"digest":{"description":"Content digest of the artifact","title":"Digest is the content digest of the artifact","type":"string","uniqueKey":"artifacts.items.[INDEX].digest","typeLabel":"string"}},"title":"ComponentArtifact","type":"object","uniqueKey":"artifacts.items.[INDEX]","typeLabel":"ComponentArtifact · object"},"title":"Artifacts is the list of artifacts associated with this component (e.g., container images that this component represents)","type":"array","uniqueKey":"artifacts","typeLabel":"ComponentArtifact · object[]"}},"title":"ComponentServiceDescribeResponse","type":"object","uniqueKey":"","typeLabel":"ComponentServiceDescribeResponse · object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"description":"A successful response.","exampleType":"generated"},"f3a088e9-0d89-41b1-afce-fa1603c2da5c":{"content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional details about the error.","items":{"type":"string","uniqueKey":"details.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"details","typeLabel":"string[]"}},"required":["code","message"],"title":"BadRequestResponse","type":"object","uniqueKey":"","typeLabel":"BadRequestResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":0,"details":["details","details"],"message":"message"}}},"exampleType":"generated"}},"description":"Bad Request - The request was invalid or cannot be served.","exampleType":"generated"},"b5cce41f-342e-47df-9144-094d556716e3":{"content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional details about the error.","items":{"type":"string","uniqueKey":"details.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"details","typeLabel":"string[]"}},"required":["code","message"],"title":"UnauthorizedResponse","type":"object","uniqueKey":"","typeLabel":"UnauthorizedResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":6,"details":["details","details"],"message":"message"}}},"exampleType":"generated"}},"description":"Unauthorized - Authentication is required.","exampleType":"generated"},"4ea6cd43-c2c1-439f-a24f-9e7c46b9330e":{"content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional details about the error.","items":{"type":"string","uniqueKey":"details.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"details","typeLabel":"string[]"}},"required":["code","message"],"title":"PermissionDeniedResponse","type":"object","uniqueKey":"","typeLabel":"PermissionDeniedResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":1,"details":["details","details"],"message":"message"}}},"exampleType":"generated"}},"description":"Forbidden - You do not have permission to access this resource.","exampleType":"generated"},"156ca72c-0726-4ad9-a2fd-d13ae11b7705":{"content":{"application/json":{"schema":{"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","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"description":"A human-readable message providing more details about the error.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"description":"Additional details about the error.","items":{"type":"string","uniqueKey":"details.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"details","typeLabel":"string[]"}},"required":["code","message"],"title":"InternalServerErrorResponse","type":"object","uniqueKey":"","typeLabel":"InternalServerErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"code":5,"details":["details","details"],"message":"message"}}},"exampleType":"generated"}},"description":"Internal Server Error - An unexpected error occurred on the server.","exampleType":"generated"},"d394f853-0118-4ee4-ad68-66fb5d171fbd":{"content":{"application/json":{"schema":{"example":{"code":5,"details":[{"@type":"@type"},{"@type":"@type"}],"message":"message"},"properties":{"code":{"format":"int32","type":"integer","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"details":{"items":{"additionalProperties":{"type":"object","uniqueKey":"details.items.[INDEX].additionalProperties","typeLabel":"object"},"example":{"@type":"@type"},"properties":{"@type":{"type":"string","uniqueKey":"details.items.[INDEX].@type","typeLabel":"string"}},"type":"object","uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"details","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":5,"details":[{"@type":"@type"},{"@type":"@type"}],"message":"message"}}},"exampleType":"generated"}},"description":"An unexpected error response.","exampleType":"generated"}},"security":{"d219d3b3-f34a-4604-bff4-947dbe85e4f8":{"bearerToken":{"description":"Bearer token for authentication","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerToken"}}},"servers":{"27e6ed67-0727-4ed5-954e-6ef60eb45150":{"url":"https://api.app.chainloop.dev/"}},"schemas":{"640ab205-656b-41f2-8bc6-f6070b1486fb":{"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":{"$circularRef":"640ab205-656b-41f2-8bc6-f6070b1486fb"},"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":{"$circularRef":"640ab205-656b-41f2-8bc6-f6070b1486fb"},"title":"Children is the list of child components (dependencies) of this component","type":"array"},"findings_summary":{"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"}},"title":"ComponentItem","type":"object"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Bearer token for authentication","type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token for authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerToken","name":"Authorization"}],"title":"bearerToken"}]},"originalFileLocation":"https://api.app.chainloop.dev/openapi.yaml"},"subdomain":"chainloop","siteName":"Chainloop Documentation","title":"Describe a component - Chainloop Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T11:05:01.878Z","originalFileLocation":"api-reference/componentservice/describe-a-component.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns detailed information about a component and all projects/versions where it appears\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chainloop Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Describe a component - Chainloop Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns detailed information about a component and all projects/versions where it appears\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chainloop Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chainloop.mintlify.app/_mintlify/api/og/v2?division=ComponentService\u0026amp;title=Describe+a+component\u0026amp;description=Returns+detailed+information+about+a+component+and+all+projects%2Fversions+where+it+appears\u0026amp;theme=61c93c80cca4eee0101862fb\u0026amp;signature=ba2f838dc33e16c89b40a57c2a6cf839e2356718e81ed44e1b951df79727b699\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Describe a component - Chainloop Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns detailed information about a component and all projects/versions where it appears\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chainloop.mintlify.app/_mintlify/api/og/v2?division=ComponentService\u0026amp;title=Describe+a+component\u0026amp;description=Returns+detailed+information+about+a+component+and+all+projects%2Fversions+where+it+appears\u0026amp;theme=61c93c80cca4eee0101862fb\u0026amp;signature=ba2f838dc33e16c89b40a57c2a6cf839e2356718e81ed44e1b951df79727b699\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/chainloop/mw3ai7qmEaYOPNu0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chainloop Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2D1BD2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/componentservice/describe-a-component.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chainloop.dev/#organization\",\"name\":\"Chainloop Documentation\",\"url\":\"https://docs.chainloop.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chainloop/piBVJM34fSFTGk0R/images/logo/light.svg?fit=max\u0026auto=format\u0026n=piBVJM34fSFTGk0R\u0026q=85\u0026s=4bc355683f7e78c629ece2e28db71dff\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chainloop.dev#website\",\"name\":\"Chainloop Documentation\",\"url\":\"https://docs.chainloop.dev\",\"publisher\":{\"@id\":\"https://docs.chainloop.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component#webpage\",\"url\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component\",\"name\":\"Describe a component\",\"description\":\"Returns detailed information about a component and all projects/versions where it appears\",\"dateModified\":\"2026-10-22T11:05:01.878Z\",\"isPartOf\":{\"@id\":\"https://docs.chainloop.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform Endpoints\",\"item\":\"https://docs.chainloop.dev/api-reference/agentsservice/evaluate-evidence-with-ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ComponentService\",\"item\":\"https://docs.chainloop.dev/api-reference/componentservice/list-software-components\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Describe a component\",\"item\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component#apireference\",\"headline\":\"Describe a component\",\"name\":\"Describe a component\",\"description\":\"Returns detailed information about a component and all projects/versions where it appears\",\"url\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chainloop.dev/api-reference/componentservice/describe-a-component#webpage\"},\"dateModified\":\"2026-10-22T11:05:01.878Z\",\"publisher\":{\"@id\":\"https://docs.chainloop.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chainloop.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chainloop Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chainloop Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://chainloop.dev/"},{"anchor":"Blog","icon":"newspaper","href":"https://chainloop.dev/blog"},{"anchor":"Get Help","icon":"headset","href":"https://help.chainloop.dev"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"Reference","menu":[{"item":"CLI Reference","icon":"terminal","pages":[{"title":"CLI Reference","href":"/cli/installation"}]},{"item":"API Reference","icon":"code","groups":[{"group":" ","pages":[{"title":"Overview","href":"/api-reference/overview"}]},{"group":"Chainloop Controlplane Endpoints","pages":[{"group":"ReferrerService","pages":[{"title":"Discover private referrer","deprecated":null,"version":null,"openapi":"https://cp.chainloop.dev/openapi.yaml get /discover/{digest}","href":"/api-reference/referrerservice/discover-private-referrer"}]},{"group":"DownloadService","pages":[{"title":"Download Artifacts from CAS","deprecated":null,"version":null,"openapi":"https://cp.chainloop.dev/openapi.yaml get /download/{digest}","href":"/api-reference/downloadservice/download-artifacts-from-cas"}]}]},{"group":"Platform Endpoints","pages":[{"group":"AgentsService","pages":[{"title":"Evaluate evidence with AI","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/agents/evaluate-evidence","href":"/api-reference/agentsservice/evaluate-evidence-with-ai"}]},{"group":"ArtifactService","pages":[{"title":"List artifacts","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/artifacts","href":"/api-reference/artifactservice/list-artifacts"},{"title":"Describe an artifact","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/artifacts/{id}","href":"/api-reference/artifactservice/describe-an-artifact"}]},{"group":"AssessmentService","pages":[{"title":"List assessments","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/assessments","href":"/api-reference/assessmentservice/list-assessments"},{"title":"Create an assessment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/assessments","href":"/api-reference/assessmentservice/create-an-assessment"},{"title":"Trigger auto-assessment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/assessments/auto","href":"/api-reference/assessmentservice/trigger-auto-assessment"},{"title":"List effective assessments for lookups","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/assessments/list-effective","href":"/api-reference/assessmentservice/list-effective-assessments-for-lookups"},{"title":"Approve an assessment revision","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/assessments/revisions/{revision_id}/approve","href":"/api-reference/assessmentservice/approve-an-assessment-revision"},{"title":"Reject an assessment revision","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/assessments/revisions/{revision_id}/reject","href":"/api-reference/assessmentservice/reject-an-assessment-revision"},{"title":"Get assessment summary","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/assessments/summary","href":"/api-reference/assessmentservice/get-assessment-summary"},{"title":"List assessment revisions","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/assessments/{assessment_id}/revisions","href":"/api-reference/assessmentservice/list-assessment-revisions"},{"title":"Get an assessment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/assessments/{id}","href":"/api-reference/assessmentservice/get-an-assessment"},{"title":"Update an assessment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml put /v1/assessments/{id}","href":"/api-reference/assessmentservice/update-an-assessment"},{"title":"Delete an assessment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml delete /v1/assessments/{id}","href":"/api-reference/assessmentservice/delete-an-assessment"}]},{"group":"AttestationsService","pages":[{"title":"Creates and attestation from a piece of content","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/attestations","href":"/api-reference/attestationsservice/creates-and-attestation-from-a-piece-of-content"}]},{"group":"ComplianceService","pages":[{"title":"List a policy evaluation's violations","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/compliance/policy-evaluations/{policy_evaluation_id}/violations","href":"/api-reference/complianceservice/list-a-policy-evaluations-violations"},{"title":"Get product-level compliance aggregation","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/compliance/product","href":"/api-reference/complianceservice/get-product-level-compliance-aggregation"},{"title":"Get single-requirement product compliance detail","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/compliance/product/requirement","href":"/api-reference/complianceservice/get-single-requirement-product-compliance-detail"},{"title":"Get lightweight product compliance summary","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/compliance/product/summary","href":"/api-reference/complianceservice/get-lightweight-product-compliance-summary"},{"title":"Get project-level compliance evaluation","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/compliance/project","href":"/api-reference/complianceservice/get-project-level-compliance-evaluation"}]},{"group":"ComponentService","pages":[{"title":"List software components","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/components","href":"/api-reference/componentservice/list-software-components"},{"title":"Summarize components","description":"Return aggregate component counts (total / vulnerable / fixable / exploitable) for a project version.","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/components/summary","href":"/api-reference/componentservice/summarize-components"},{"title":"Describe a component","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/components/{id}","href":"/api-reference/componentservice/describe-a-component"}]},{"group":"EnvironmentsService","pages":[{"title":"List deployment names","description":"Returns distinct deployment names with optional filtering by environment, logical environment, and search query.","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/deployment-names","href":"/api-reference/environmentsservice/list-deployment-names"},{"title":"List deployment records","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/deployments","href":"/api-reference/environmentsservice/list-deployment-records"},{"title":"Record a deployment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/deployments","href":"/api-reference/environmentsservice/record-a-deployment"},{"title":"List environments","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/environments","href":"/api-reference/environmentsservice/list-environments"},{"title":"Create an environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/environments","href":"/api-reference/environmentsservice/create-an-environment"},{"title":"Describe an environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/environments/{id}","href":"/api-reference/environmentsservice/describe-an-environment"},{"title":"Update an environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml put /v1/environments/{id}","href":"/api-reference/environmentsservice/update-an-environment"},{"title":"Delete an environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml delete /v1/environments/{id}","href":"/api-reference/environmentsservice/delete-an-environment"}]},{"group":"EvidenceService","pages":[{"title":"List pieces of evidence","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/evidence","href":"/api-reference/evidenceservice/list-pieces-of-evidence"},{"title":"Describe a piece of evidence","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/evidence/{id}","href":"/api-reference/evidenceservice/describe-a-piece-of-evidence"}]},{"group":"FindingService","pages":[{"title":"List findings","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/findings","href":"/api-reference/findingservice/list-findings"},{"title":"Trigger auto-remediation","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/findings/auto-remediation","href":"/api-reference/findingservice/trigger-auto-remediation"},{"title":"Ingest SBOM findings","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/findings/ingest-sbom","href":"/api-reference/findingservice/ingest-sbom-findings"},{"title":"Summarize findings","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/findings/summary","href":"/api-reference/findingservice/summarize-findings"},{"title":"Describe a finding","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/findings/{finding_id}","href":"/api-reference/findingservice/describe-a-finding"},{"title":"Update a finding","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml put /v1/findings/{finding_id}","href":"/api-reference/findingservice/update-a-finding"},{"title":"Delete a finding","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml delete /v1/findings/{finding_id}","href":"/api-reference/findingservice/delete-a-finding"}]},{"group":"PolicyService","pages":[{"title":"Get a policy group by name","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/groups/{group_name}","href":"/api-reference/policyservice/get-a-policy-group-by-name"},{"title":"Update an existing policy","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml put /v1/policies","href":"/api-reference/policyservice/update-an-existing-policy"},{"title":"Create a new policy","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/policies","href":"/api-reference/policyservice/create-a-new-policy"},{"title":"Validate a policy attachment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/policies/validate","href":"/api-reference/policyservice/validate-a-policy-attachment"},{"title":"Get a policy by name","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/policies/{policy_name}","href":"/api-reference/policyservice/get-a-policy-by-name"},{"title":"Remove a policy from the list","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml delete /v1/policies/{policy_name}","href":"/api-reference/policyservice/remove-a-policy-from-the-list"}]},{"group":"LogicalEnvironmentsService","pages":[{"title":"List logical environments","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/logical-environments","href":"/api-reference/logicalenvironmentsservice/list-logical-environments"},{"title":"Create a logical environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/logical-environments","href":"/api-reference/logicalenvironmentsservice/create-a-logical-environment"},{"title":"Describe a logical environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/logical-environments/{id}","href":"/api-reference/logicalenvironmentsservice/describe-a-logical-environment"},{"title":"Update a logical environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml put /v1/logical-environments/{id}","href":"/api-reference/logicalenvironmentsservice/update-a-logical-environment"},{"title":"Delete a logical environment","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml delete /v1/logical-environments/{id}","href":"/api-reference/logicalenvironmentsservice/delete-a-logical-environment"}]},{"group":"AsyncOperationsService","pages":[{"title":"List async operations","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/operations","href":"/api-reference/asyncoperationsservice/list-async-operations"},{"title":"Dispatch a managed workflow scan","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml post /v1/operations/dispatch-workflow-scan","href":"/api-reference/asyncoperationsservice/dispatch-a-managed-workflow-scan"},{"title":"Get async operation status","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/operations/{operation_id}","href":"/api-reference/asyncoperationsservice/get-async-operation-status"}]},{"group":"ProductsService","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/products","href":"/api-reference/productsservice/list-products"},{"title":"Get product version details","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/products/{product_id}/versions/{version_id}","href":"/api-reference/productsservice/get-product-version-details"}]},{"group":"ProjectsService","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/projects","href":"/api-reference/projectsservice/list-projects"}]},{"group":"UserService","pages":[{"title":"Get current user information","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/users/info","href":"/api-reference/userservice/get-current-user-information"}]},{"group":"WorkflowTemplateService","pages":[{"title":"List workflow templates","deprecated":null,"version":null,"openapi":"https://api.app.chainloop.dev/openapi.yaml get /v1/workflow-templates","href":"/api-reference/workflowtemplateservice/list-workflow-templates"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Describe a component - Chainloop Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}