> ## 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. # The fleet's software bill of materials (browser session) > Every package the scanner found in the fleet's container images, grouped by name, version and ecosystem, with how many images, workloads and clusters carry it and the findings that name that exact package and version on those images. The coverage block says how many scanned clusters publish a bill of materials; the rest have SBOM generation switched off. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /org/security/sbom openapi: 3.1.0 info: title: Ankra Platform API version: v1 description: >- The Ankra platform HTTP contract. The /api/v1 surface is the public, bearer-authenticated API used by the Ankra CLI, MCP clients and automation; send a personal or service API token as `Authorization: Bearer `. Browser routes under /org and /chat are served on api.platform.ankra.app (each declares that server); they and /oauth/access authenticate with the ankra_session cookie, and mutations also require the X-Ankra-CSRF header. Every operation declares the credential it accepts, and no operation is served without one. This document is published deliberately: it describes the contract only and carries no organisation data or credentials. Report security issues to security@ankra.ai (see /.well-known/security.txt). servers: - url: https://platform.ankra.app security: - BearerAuth: [] tags: - name: Onboarding description: >- Generate a first website from a prompt and deploy it to a new organisation's cluster. - name: Access Gate description: >- Private service sign-in and membership checks for trusted Ankra proxy relays. - name: Canvas Datasets description: >- Read the fixed, named datasets canvas dashboards bind their charts, tables and stats to. - name: Canvases description: >- Keep dashboards and pages in the organisation's canvas library, with revision history, undo and pins. - name: Canvas Pages description: >- Publish a chat canvas artifact at a public pages address and take it down again. - name: Cloud Delegation description: >- Platform browser consent and organisation-bound connections for Ankra Cloud. - name: Organisation IAM description: >- Custom organisation roles and scoped role assignments for member and service-account identities. - 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: AWS Clusters description: >- Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in your own VPC. - name: Ankra Cloud Clusters description: >- Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud servers: a private network, a NAT router and a bastion per 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: Pipelines description: >- Pipeline definitions, the approval of the authority they declare, and the caches pipelines keep between runs. - name: Workspaces description: >- Personal workspaces on the organisation's CI pool where a repository's heavy commands run, and the repository profiles they are built from. - name: Deploy Targets description: >- Environments, the hosts registered to receive deployments, and the releases deployed to them. - name: Deploy Provenance description: >- Whether an application's deploys verify signed provenance from the organisation's own pipeline, the keys that provenance is signed with, and a dry-run that verifies images without deploying. - name: Backups description: >- Backup vaults, restore points, protection posture and captures for stacks and application deployments; a completed capture is not a verified restore. - name: Stack Profiles description: Reusable stack definitions, their versions and sharing. - name: Services description: >- Versioned service packages and explicit sharing. Runtime admission is separate from publication. - 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 Management description: >- Customer agent lifecycle, authenticated identity and organisation automation controls. - 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 Remediation description: >- The organisation's auto-remediation policy: what the AI lanes may fix by themselves, and who approves the rest. - 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: AI Memory description: >- What the assistant has learned about you: your cross-session memories and learned profile. - name: MCP Servers description: >- Register the MCP servers the organisation's AI agents can call, choose their tools and grant them to roles. - name: Security description: Findings, advisories, SBOMs, compliance and posture. - name: Cost description: Cluster and fleet cost, rate cards and cost settings. - name: Decisions description: >- The decision ledger behind the Security and Cost queues: proposals a surface computed, the approve and set-aside decisions people took on them, and the receipts of running them. - name: Usage description: >- What your organisation used of Ankra - vCPU-hours, playgrounds, managed services, hosted logs and metrics, and AI - per meter and period, with how completely it was measured and whether a published rate applies. - name: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - name: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address. - name: Account Tokens description: Personal access tokens for the API and CLI. - name: Credentials description: The shared credential store. - name: AWS Credentials description: >- AWS credentials: access keys or CloudFormation-onboarded STS roles for cost, EKS and self-managed provisioning. - name: Ankra Cloud Credentials description: >- Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud lanes. - 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: HPE Morpheus Credentials description: HPE Morpheus credentials and the capacity and quotas behind them. - name: OVH Credentials description: OVH credentials and SSH keys. - name: Proxmox Credentials description: Proxmox VE credentials and the capacity and quotas behind them. - 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: Object Storage Buckets description: >- Buckets Ankra creates and manages on an organisation's own provider credentials. - name: DNS description: DNS zones and records, including custom organisation zones. - name: Cloudflare description: Cloudflare domains and the credentials behind them. - name: Avura description: >- The linked Avura organization, the domains it shares with Ankra Platform, and their DNS records. - name: Variables description: Organisation- and cluster-scoped variables. - name: Secret Slots description: >- Store secrets in Vault and reference them by ${SECRET_SLOT:} sentinel instead of by value. - 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. - name: AI Settings description: Organisation AI provider, model catalog and per-function model settings paths: /org/security/sbom: get: tags: - Security summary: The fleet's software bill of materials (browser session) description: >- Every package the scanner found in the fleet's container images, grouped by name, version and ecosystem, with how many images, workloads and clusters carry it and the findings that name that exact package and version on those images. The coverage block says how many scanned clusters publish a bill of materials; the rest have SBOM generation switched off. operationId: list_security_sbom_components parameters: - in: query name: page required: false schema: default: 1 maximum: 10000 minimum: 1 type: integer - description: Values above 100 are clamped to 100. in: query name: page_size required: false schema: default: 50 minimum: 1 type: integer - in: query name: search required: false schema: type: string - description: >- Ecosystem filter, repeatable (deb, apk, rpm, npm, pypi, golang, maven, ...). in: query name: package_type required: false schema: type: array items: type: string - description: >- Only components in these licence tiers (network_copyleft, source_available, copyleft, weak_copyleft, permissive, unknown); repeat or comma-separate to combine. in: query name: license_risk required: false schema: type: array items: type: string - in: query name: cluster_id required: false schema: type: string format: uuid - in: query name: namespace required: false schema: type: string - description: >- Only images running in workloads of this kind (Deployment, StatefulSet, DaemonSet, CronJob, ...); case-insensitive. in: query name: workload_kind required: false schema: type: string - description: >- Only images running in the workload with this name; case-insensitive. Combine with workload_kind to pin one workload. in: query name: workload_name required: false schema: type: string - description: >- Only components inside one image (digest or repository:tag identity). in: query name: image required: false schema: type: string - description: true keeps components a finding names, false the ones nothing names. in: query name: vulnerable required: false schema: type: boolean - in: query name: sort required: false schema: default: images enum: - name - version - package_type - images - workloads - clusters - vulnerable - actionable type: string - in: query name: order required: false schema: default: desc enum: - asc - desc type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecuritySbomComponentListResponse' 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 security: - SessionCookie: [] servers: - url: https://api.platform.ankra.app components: schemas: SecuritySbomComponentListResponse: properties: result: items: $ref: '#/components/schemas/SecuritySbomComponentSummary' type: array pagination: $ref: '#/components/schemas/SecurityPagination' facets: $ref: '#/components/schemas/SecuritySbomComponentFacets' coverage: $ref: '#/components/schemas/SecuritySbomCoverage' required: - result - pagination - facets - coverage title: SecuritySbomComponentListResponse 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: type: array items: type: string 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 SecurityPagination: properties: page: type: integer page_size: type: integer total_count: type: integer total_pages: type: integer required: - page - page_size - total_pages - total_count type: object SecuritySbomComponentFacets: properties: package_type: items: $ref: '#/components/schemas/SecurityFacetCount' type: array license_risk: items: $ref: '#/components/schemas/SecurityFacetCount' type: array description: Tiers present under the other filters, most consequential first. required: - package_type - license_risk title: SecuritySbomComponentFacets type: object SecuritySbomCoverage: properties: scanned_clusters: type: integer clusters_with_sbom: description: >- Below scanned_clusters means the remaining clusters have SBOM generation switched off, not that they run nothing. type: integer images: type: integer components: type: integer workloads: type: integer latest_generated_at: anyOf: - type: string format: date-time - type: 'null' required: - scanned_clusters - clusters_with_sbom - images - components - workloads - latest_generated_at title: SecuritySbomCoverage 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 SecurityFacetCount: properties: count: type: integer value: type: string required: - value - count type: object securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http SessionCookie: description: Browser session. Mutations also require X-Ankra-CSRF. in: cookie name: ankra_session type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.