> ## Documentation Index > Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt > Use this file to discover all available pages before exploring further. # Where one package runs: the images carrying it, the workload containers running them, and their clusters ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /org/security/sbom/component openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - name: Clusters description: Create, inspect and manage clusters, and the stacks deployed on them. - name: Managed Clusters description: Provider-managed control planes, driven through one common surface. - name: Imported Clusters description: Clusters that already existed and were connected to Ankra. - name: Cluster Access description: Kubeconfigs, service-account tokens and per-cluster access grants. - name: Kubernetes description: Read and act on the Kubernetes objects inside a cluster. - name: DigitalOcean Clusters description: Provision and manage DigitalOcean Kubernetes clusters. - name: Hetzner Clusters description: Provision and manage Hetzner Kubernetes clusters. - name: OVH Clusters description: Provision and manage OVH Kubernetes clusters. - name: Scaleway Clusters description: Provision and manage Scaleway Kapsule clusters. - name: UpCloud Clusters description: Provision and manage UpCloud Kubernetes clusters. - name: Applications description: Deploy, configure and observe applications across the fleet. - name: Stack Profiles description: Reusable stack definitions, their versions and sharing. - name: Charts description: Browse the chart catalogue behind stacks and addons. - name: Helm description: Helm registries, credentials and the charts they expose. - name: Executions description: Long-running platform executions and their jobs. - name: Operations description: Cancel in-flight cluster operations and their jobs. - name: Chat description: Conversational sessions, plans and confirmable actions. - name: AI Agent Runs description: Autonomous agent runs and their outcomes. - name: AI Tickets description: The AI ticket board, its sync connections and settings. - name: AI Playbooks description: Reusable playbooks the AI lanes execute. - name: AI Conditions description: Conditions that gate AI autonomy. - name: AI Engineering Handoffs description: Work the AI lanes escalate to a human engineer. - name: AI Environment description: The environment and base stacks AI demos deploy into. - name: Security description: Findings, advisories, SBOMs, compliance and posture. - name: Cost description: Cluster and fleet cost, rate cards and cost settings. - name: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - name: Account Tokens description: Personal access tokens for the API and CLI. - name: Credentials description: The shared credential store. - name: Azure Credentials description: Azure credentials and SSH keys. - name: DigitalOcean Credentials description: DigitalOcean credentials and SSH keys. - name: Hetzner Credentials description: Hetzner credentials and SSH keys. - name: OVH Credentials description: OVH credentials and SSH keys. - name: Scaleway Credentials description: Scaleway credentials. - name: UpCloud Credentials description: UpCloud credentials and SSH keys. - name: Data Source Credentials description: Credentials for metrics and log sources. - name: DNS Credentials description: Credentials for DNS providers. - name: DNS description: DNS zones and records, including custom organisation zones. - name: Cloudflare description: Cloudflare domains and the credentials behind them. - name: Variables description: Organisation- and cluster-scoped variables. - name: SOPS description: Encrypt and decrypt values with the organisation SOPS config. - name: Alerts description: Alert integrations and ingest credentials. - name: Notifications description: Notification routes and their delivery targets. - name: Support description: Support tickets. paths: /org/security/sbom/component: get: tags: - Security summary: >- Where one package runs: the images carrying it, the workload containers running them, and their clusters operationId: get_security_sbom_component parameters: - name: name in: query required: true schema: type: string description: The package name as the component list shows it (case-insensitive). - name: version in: query required: false schema: default: '' type: string description: The exact installed version; empty when the list shows none. - name: package_type in: query required: true schema: type: string description: The ecosystem (apk, deb, rpm, npm, pypi, golang, maven, ...). - name: cluster_id in: query required: false schema: format: uuid type: string description: >- Only the images, workload containers and clusters on this cluster; omit for the whole fleet. responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecuritySbomComponentDetailResponse' description: Successful response '400': content: application/json: schema: $ref: '#/components/schemas/SecurityDetailError' description: Business validation error '403': content: application/json: schema: $ref: '#/components/schemas/SecurityPermissionDenied' description: Permission denied '404': content: application/json: schema: $ref: '#/components/schemas/SecurityDetailError' description: Organization-scoped resource not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error components: schemas: SecuritySbomComponentDetailResponse: properties: component: $ref: '#/components/schemas/SecuritySbomComponentSummary' images: items: $ref: '#/components/schemas/SecuritySbomImageSummary' type: array description: >- Images whose bill of materials names the exact package and version, most-run first, capped at 200. images_capped: type: boolean workloads: items: $ref: '#/components/schemas/SecuritySbomComponentWorkload' type: array description: >- Workload containers currently running an image that carries the component, one row per container, capped at 500; computed over every carrying image, not only the ones the images list holds when capped, and each row carries its own image identity. workloads_capped: type: boolean clusters: items: $ref: '#/components/schemas/SecuritySbomComponentCluster' type: array description: Clusters running the component, over every carrying image. required: - component - images - images_capped - workloads - workloads_capped - clusters title: SecuritySbomComponentDetailResponse type: object SecurityDetailError: properties: detail: type: string required: - detail type: object SecurityPermissionDenied: properties: detail: enum: - permission_denied type: string permission: type: string scope_type: type: string required: - detail - permission - scope_type type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object SecuritySbomComponentSummary: properties: name: type: string version: type: string package_type: type: string component_type: type: string purl: anyOf: - type: string - type: 'null' licenses: items: type: string type: array license_risk: type: string enum: - network_copyleft - source_available - copyleft - weak_copyleft - permissive - unknown description: >- The most consequential licence tier across the component's licences: network_copyleft (AGPL, SSPL, EUPL, OSL) obliges publishing the source of a service that links it; source_available (BUSL, Elastic, Redis Source Available, Commons Clause) needs a commercial licence to host as a service; copyleft (GPL) is safe on a private backend but must be open-sourced when shipped to users; weak_copyleft (LGPL, MPL, EPL, CDDL) reaches only modifications of the component; permissive (MIT, Apache-2.0, BSD, ISC) obliges nothing; unknown is unrecognised or not yet classified. images: type: integer workloads: type: integer clusters: type: integer vulnerable_findings: type: integer actionable_findings: type: integer known_exploited: type: integer required: - name - version - package_type - component_type - purl - licenses - license_risk - images - workloads - clusters - vulnerable_findings - actionable_findings - known_exploited title: SecuritySbomComponentSummary type: object SecuritySbomImageSummary: properties: image_identity: type: string image_ref: type: string image_repository: anyOf: - type: string - type: 'null' image_tag: anyOf: - type: string - type: 'null' image_digest: anyOf: - type: string - type: 'null' registry: anyOf: - type: string - type: 'null' os_family: anyOf: - type: string - type: 'null' os_name: anyOf: - type: string - type: 'null' bom_format: anyOf: - type: string - type: 'null' spec_version: anyOf: - type: string - type: 'null' component_count: type: integer dependency_count: type: integer workloads: type: integer clusters: type: integer namespaces: items: type: string type: array observed: type: integer actionable: $ref: '#/components/schemas/SecuritySeverityCounts' known_exploited: type: integer license_exposure: $ref: '#/components/schemas/SecurityLicenseExposure' generated_at: anyOf: - format: date-time type: string - type: 'null' first_seen_at: format: date-time type: string last_seen_at: format: date-time type: string required: - image_identity - image_ref - image_repository - image_tag - image_digest - registry - os_family - os_name - bom_format - spec_version - component_count - dependency_count - workloads - clusters - namespaces - observed - actionable - known_exploited - license_exposure - generated_at - first_seen_at - last_seen_at title: SecuritySbomImageSummary type: object SecuritySbomComponentWorkload: properties: cluster_id: format: uuid type: string cluster_name: type: string report_scope: type: string workload_kind: anyOf: - type: string - type: 'null' workload_namespace: anyOf: - type: string - type: 'null' workload_name: anyOf: - type: string - type: 'null' container_name: anyOf: - type: string - type: 'null' image_identity: type: string image_ref: type: string last_seen_at: format: date-time type: string required: - cluster_id - cluster_name - report_scope - workload_kind - workload_namespace - workload_name - container_name - image_identity - image_ref - last_seen_at title: SecuritySbomComponentWorkload type: object SecuritySbomComponentCluster: properties: cluster_id: format: uuid type: string cluster_name: type: string workloads: type: integer description: >- Distinct workloads on the cluster carrying the component, the measure the component row counts. containers: type: integer description: >- Workload containers on the cluster running an image that carries the component; the Workloads list holds one row per container. images: type: integer required: - cluster_id - cluster_name - workloads - containers - images title: SecuritySbomComponentCluster type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object SecuritySeverityCounts: properties: critical: type: integer high: type: integer low: type: integer medium: type: integer unknown: type: integer required: - critical - high - medium - low - unknown type: object SecurityLicenseExposure: properties: network_copyleft: type: integer source_available: type: integer copyleft: type: integer weak_copyleft: type: integer permissive: type: integer unknown: type: integer required: - network_copyleft - source_available - copyleft - weak_copyleft - permissive - unknown title: SecurityLicenseExposure type: object description: >- Components per licence tier. A component the classifier has not seen yet counts as unknown, never as permissive. ````