> ## 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 organisation's CI usage history > How the organisation's CI clusters have been used over a window of 24h, 7d or 30d, per cluster and per time bucket: steps started, the time-weighted average and peak number of steps running, the CPU and memory those steps requested and the CPU they used, and how long they waited for a slot. It is folded from the organisation's pipeline steps on its own clusters (steps Ankra's builders ran are not counted), so it reaches back no further than run_retention_days. A requested or used figure is null when steps ran and none recorded it and zero when nothing ran; request_coverage and usage_coverage give the share of step running time that recorded it. The slot count and node capacity at the time are not recorded; read today's from the capacity route. 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/history 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/history: get: tags: - Pipelines summary: Read the organisation's CI usage history description: >- How the organisation's CI clusters have been used over a window of 24h, 7d or 30d, per cluster and per time bucket: steps started, the time-weighted average and peak number of steps running, the CPU and memory those steps requested and the CPU they used, and how long they waited for a slot. It is folded from the organisation's pipeline steps on its own clusters (steps Ankra's builders ran are not counted), so it reaches back no further than run_retention_days. A requested or used figure is null when steps ran and none recorded it and zero when nothing ran; request_coverage and usage_coverage give the share of step running time that recorded it. The slot count and node capacity at the time are not recorded; read today's from the capacity route. Readable by any member. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication). operationId: getPipelineCapacityHistoryToken parameters: - name: window in: query required: false schema: type: string enum: - 24h - 7d - 30d default: 24h description: >- The span to read: 48 buckets of 30 minutes, 56 of 3 hours, or 60 of 12 hours. responses: '200': description: The organisation's CI usage over the window. content: application/json: schema: $ref: '#/components/schemas/PipelineCapacityHistory' '401': description: Authentication required '422': description: The window is not 24h, 7d or 30d. '500': description: Internal error security: - BearerAuth: [] components: schemas: PipelineCapacityHistory: type: object description: The organisation's CI usage over one window (ankra-q573dh.57). required: - window - bucket_seconds - from - to - run_retention_days - is_capped - clusters properties: window: type: string enum: - 24h - 7d - 30d bucket_seconds: type: integer from: type: string format: date-time to: type: string format: date-time description: End of the newest bucket, which is still going. run_retention_days: type: integer description: >- How long the organisation keeps pipeline runs; a window reaching further back is empty there, not idle. is_capped: type: boolean description: >- The window held more steps than one read folds; the newest were kept, so the oldest buckets undercount. clusters: type: array items: $ref: '#/components/schemas/PipelineCapacityHistoryCluster' description: >- Every current member of the organisation's CI pool, primary first, then any other of its clusters a step ran on in the window. title: PipelineCapacityHistory PipelineCapacityHistoryCluster: type: object description: One CI cluster's buckets, oldest first. required: - cluster_id - cluster_name - buckets properties: cluster_id: type: string format: uuid cluster_name: type: string buckets: type: array items: $ref: '#/components/schemas/PipelineCapacityHistoryBucket' title: PipelineCapacityHistoryCluster PipelineCapacityHistoryBucket: type: object description: >- One time bucket of one CI cluster. Averages are over the part of the bucket that has passed. required: - start - steps_started - average_steps_running - peak_steps_running - cpu_requested_millicores - memory_requested_bytes - request_coverage - cpu_used_millicores - usage_coverage - slot_wait_average_seconds - slot_wait_max_seconds properties: start: type: string format: date-time steps_started: type: integer description: Steps that started on the cluster in the bucket. average_steps_running: type: number description: Time-weighted average number of steps running. peak_steps_running: type: integer description: Most steps running at any one moment. cpu_requested_millicores: anyOf: - type: integer - type: 'null' description: >- Time-weighted average CPU requested by running steps; null when steps ran and none recorded requests. memory_requested_bytes: anyOf: - type: integer - type: 'null' description: >- Time-weighted average memory requested by running steps; null when steps ran and none recorded requests. request_coverage: type: number description: Share of step running time whose requests were recorded, 0 to 1. cpu_used_millicores: anyOf: - type: integer - type: 'null' description: >- Time-weighted average CPU the steps used, from the agent's cgroup samples; null when steps ran and none was sampled. usage_coverage: type: number description: Share of step running time whose CPU use was sampled, 0 to 1. slot_wait_average_seconds: anyOf: - type: number - type: 'null' description: >- Average time from dispatch to an agent slot picking the step up, over the steps that started in the bucket; null when none recorded a dispatch time. slot_wait_max_seconds: anyOf: - type: number - type: 'null' description: Longest such wait in the bucket. title: PipelineCapacityHistoryBucket securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.