> ## 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. # Read the CPU and memory of the organisation's CI clusters > The CPU and memory of the nodes each member of the organisation's CI pool places pipelines on: their summed allocatable, what every pod on them requests, and the part pipeline pods request, from the platform's mirror of each cluster. Members come primary first, as in the capacity read's pool_members. It is read apart from the capacity read because it reads every node and running pod of each cluster; each cluster's answer is reused for up to a minute. A member whose nodes could not be read answers state unknown with every figure null. Readable by any member. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication). ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/ci-settings/capacity/resources openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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: 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: 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: 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: /api/v1/org/ci-settings/capacity/resources: get: tags: - Pipelines summary: Read the CPU and memory of the organisation's CI clusters description: >- The CPU and memory of the nodes each member of the organisation's CI pool places pipelines on: their summed allocatable, what every pod on them requests, and the part pipeline pods request, from the platform's mirror of each cluster. Members come primary first, as in the capacity read's pool_members. It is read apart from the capacity read because it reads every node and running pod of each cluster; each cluster's answer is reused for up to a minute. A member whose nodes could not be read answers state unknown with every figure null. Readable by any member. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication). operationId: getPipelineCapacityResourcesToken responses: '200': description: Every CI pool member's CPU and memory. content: application/json: schema: $ref: '#/components/schemas/PipelineCapacityResourcesList' '401': description: Authentication required '500': description: Internal error security: - BearerAuth: [] components: schemas: PipelineCapacityResourcesList: type: object description: Every CI pool member's CPU and memory, primary first (ankra-q573dh.66). required: - members properties: members: type: array items: type: object required: - cluster_id - cluster_name - resources properties: cluster_id: type: string format: uuid cluster_name: type: string resources: $ref: '#/components/schemas/PipelineCapacityResources' title: PipelineCapacityResourcesList PipelineCapacityResources: type: object description: >- The CPU and memory of the nodes a CI pool member's pipelines are placed on, from the platform's mirror of the cluster (ankra-q573dh.55). An estimate: the mirror lags the cluster by the watch's delay. Every figure is null while state is unknown. required: - state - is_dedicated - node_group - nodes - allocatable_cpu_millicores - allocatable_memory_bytes - requested_cpu_millicores - requested_memory_bytes - ci_requested_cpu_millicores - ci_requested_memory_bytes properties: state: type: string enum: - known - unknown description: >- known: every node CI is placed on, and every pod bound to one, was read. unknown: no fresh node rows, no Ready node CI is placed on, or a quantity that could not be read. is_dedicated: type: boolean description: >- The member's CI placement names a node selector, so the figures are its CI node group's; false when CI shares the cluster's nodes with other workloads. node_group: anyOf: - type: string - type: 'null' description: >- The node group the CI placement names, when the administrator named one. nodes: anyOf: - type: integer - type: 'null' description: >- Ready, schedulable nodes CI is placed on: the CI node group's when is_dedicated, otherwise every node CI tolerates. allocatable_cpu_millicores: anyOf: - type: integer - type: 'null' description: Summed allocatable CPU of those nodes, in millicores. allocatable_memory_bytes: anyOf: - type: integer - type: 'null' description: Summed allocatable memory of those nodes, in bytes. requested_cpu_millicores: anyOf: - type: integer - type: 'null' description: CPU every pod bound to those nodes requests, in millicores. requested_memory_bytes: anyOf: - type: integer - type: 'null' description: Memory every pod bound to those nodes requests, in bytes. ci_requested_cpu_millicores: anyOf: - type: integer - type: 'null' description: >- The part of requested_cpu_millicores pipeline pods (ankra-ci, ankra-ci-build) request. ci_requested_memory_bytes: anyOf: - type: integer - type: 'null' description: >- The part of requested_memory_bytes pipeline pods (ankra-ci, ankra-ci-build) request. title: PipelineCapacityResources securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.