> ## 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 pods of one namespace joined to their scanned workload's findings (browser session)

> The running pods of one namespace on one cluster, each container joined to the findings of the scanned workload container behind it through the pod's owner chain and held to the image digest the container runs. A container without a vulnerability report is marked scanned=false; a container whose report describes another image or a replaced workload is stale, with its figures withheld. A pod is scanned only when every container is, and scan_coverage, unscanned_containers and stale_containers name the containers a partially scanned pod is missing. Narrow to one workload with workload_uid, or workload_kind and workload_name.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /org/security/pods
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 <token>`.
    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:<slot_id>}
      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/pods:
    get:
      tags:
        - Security
      summary: >-
        The pods of one namespace joined to their scanned workload's findings
        (browser session)
      description: >-
        The running pods of one namespace on one cluster, each container joined
        to the findings of the scanned workload container behind it through the
        pod's owner chain and held to the image digest the container runs. A
        container without a vulnerability report is marked scanned=false; a
        container whose report describes another image or a replaced workload is
        stale, with its figures withheld. A pod is scanned only when every
        container is, and scan_coverage, unscanned_containers and
        stale_containers name the containers a partially scanned pod is missing.
        Narrow to one workload with workload_uid, or workload_kind and
        workload_name.
      operationId: list_security_pods
      parameters:
        - in: query
          name: cluster_id
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: namespace
          required: true
          schema:
            type: string
        - in: query
          name: workload_uid
          required: false
          schema:
            type: string
        - in: query
          name: workload_kind
          required: false
          schema:
            type: string
        - in: query
          name: workload_name
          required: false
          schema:
            type: string
        - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityPodListResponse'
          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:
    SecurityPodListResponse:
      properties:
        result:
          items:
            $ref: '#/components/schemas/SecurityPodSummary'
          type: array
        pagination:
          $ref: '#/components/schemas/SecurityPagination'
        capped:
          description: true when the namespace held more pods than one read loads.
          type: boolean
      required:
        - result
        - pagination
        - capped
      title: SecurityPodListResponse
      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
    SecurityPodSummary:
      properties:
        name:
          type: string
        uid:
          anyOf:
            - type: string
            - type: 'null'
        namespace:
          type: string
        node:
          anyOf:
            - type: string
            - type: 'null'
        phase:
          anyOf:
            - type: string
            - type: 'null'
        owner_kind:
          anyOf:
            - type: string
            - type: 'null'
        owner_name:
          anyOf:
            - type: string
            - type: 'null'
        workload_kind:
          anyOf:
            - type: string
            - type: 'null'
        workload_name:
          anyOf:
            - type: string
            - type: 'null'
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        containers:
          items:
            $ref: '#/components/schemas/SecurityPodContainer'
          type: array
        scanned:
          description: >-
            True only when every container of the pod, init containers included,
            has a vulnerability report on the image it runs. One scanned
            container does not make the pod scanned.
          type: boolean
        scanned_containers:
          type: integer
        unscanned_containers:
          description: >-
            The containers no vulnerability report names, by name. A container
            whose report describes something else is in stale_containers
            instead. Empty when no container is in that state.
          items:
            type: string
          type: array
        stale_containers:
          description: >-
            The containers whose only report describes another image or a
            replaced workload, or cannot be compared, by name. Their figures are
            withheld from the pod's. Never overlaps unscanned_containers.
          items:
            type: string
          type: array
        scan_coverage:
          description: >-
            Whether every container has a vulnerability report on the image it
            runs (full), only some do (partial) or none does (none). A stale
            report does not count. A partially scanned pod is never clean.
          enum:
            - full
            - partial
            - none
          type: string
        observed:
          type: integer
        actionable:
          $ref: '#/components/schemas/SecuritySeverityCounts'
        known_exploited:
          type: integer
        fixable_severe:
          type: integer
        priority:
          enum:
            - critical
            - high
            - medium
            - low
            - unknown
            - clean
            - unscanned
          type: string
      required:
        - name
        - uid
        - namespace
        - node
        - phase
        - owner_kind
        - owner_name
        - workload_kind
        - workload_name
        - created_at
        - containers
        - scanned
        - scanned_containers
        - unscanned_containers
        - stale_containers
        - scan_coverage
        - observed
        - actionable
        - known_exploited
        - fixable_severe
        - priority
      title: SecurityPodSummary
      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
    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
    SecurityPodContainer:
      properties:
        name:
          type: string
        kind:
          description: >-
            app or init. Init containers are listed first, in the order the
            kubelet runs them.
          enum:
            - app
            - init
          type: string
        image:
          type: string
        image_digest:
          anyOf:
            - type: string
            - type: 'null'
        ready:
          type: boolean
        restart_count:
          type: integer
        scanned:
          description: >-
            true only when a report names the image digest this container runs.
            false when no report covers the container or its report describes
            something else; not the same as clean. scan_status says which.
          type: boolean
        scan_status:
          description: >-
            What the vulnerability evidence says about the image this container
            runs. scanned: a report on this workload names the digest in
            image_digest, and the figures describe it (zero findings is a clean
            image). stale: a report exists but describes another image or a
            replaced workload, or its digest cannot be compared, so its figures
            are withheld. unscanned: no report names this container.
          enum:
            - scanned
            - stale
            - unscanned
          type: string
        match_basis:
          description: >-
            What tied the report to this pod. workload_uid: a uid in the pod's
            owner chain. workload_name: kind and name only, because the report
            recorded no uid or recorded one that is not in the chain. none: no
            report.
          enum:
            - workload_uid
            - workload_name
            - none
          type: string
        stale_reason:
          anyOf:
            - enum:
                - image_digest_mismatch
                - image_digest_unknown
                - workload_replaced
              type: string
            - type: 'null'
          description: >-
            Why scan_status is stale, null otherwise. image_digest_mismatch: the
            report scanned another digest. image_digest_unknown: the report or
            the kubelet named no digest, so the two cannot be compared.
            workload_replaced: the report recorded the uid of a workload that
            has since been replaced.
        report_digest:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The image digest the matched report scanned, lower-cased. Compared
            with image_digest. null when there is no report or the report named
            no digest.
        report_observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            When the matched report was last written by the scanner. null when
            there is no report or no time is known. A pod newer than this is not
            stale on that account alone: the digest and the workload decide.
        observed:
          type: integer
        actionable:
          $ref: '#/components/schemas/SecuritySeverityCounts'
        known_exploited:
          type: integer
        fixable_severe:
          type: integer
      required:
        - name
        - kind
        - image
        - image_digest
        - ready
        - restart_count
        - scanned
        - scan_status
        - match_basis
        - stale_reason
        - report_digest
        - report_observed_at
        - observed
        - actionable
        - known_exploited
        - fixable_severe
      title: SecurityPodContainer
      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
  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.