> ## 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. # Get the application's environments > The environment ladder: every place the application runs, one row per environment (wave 1: one per cluster), derived from the deployments read and the installation rows. status is the deployment-state ladder applied to that environment's targets alone; read_state is unknown when the deployments read failed, and environments is then empty - which a client must render as could-not-check, never as no environments. address carries the raw ingress inputs; the verdict is the client's existing rule. custom_domains lists the hostnames each placement's stored ingress_extra_hosts names, each with the certificate verdict the synced cert-manager Certificates and Ingresses give it; its read_state separates none from not-on-record. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /org/applications/{application_id}/environments 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/applications/{application_id}/environments: get: tags: - Applications summary: Get the application's environments description: >- The environment ladder: every place the application runs, one row per environment (wave 1: one per cluster), derived from the deployments read and the installation rows. status is the deployment-state ladder applied to that environment's targets alone; read_state is unknown when the deployments read failed, and environments is then empty - which a client must render as could-not-check, never as no environments. address carries the raw ingress inputs; the verdict is the client's existing rule. custom_domains lists the hostnames each placement's stored ingress_extra_hosts names, each with the certificate verdict the synced cert-manager Certificates and Ingresses give it; its read_state separates none from not-on-record. operationId: get_application_environments parameters: - in: path name: application_id required: true schema: type: string title: Application Id responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationEnvironmentsResponse' description: Successful Response '404': content: application/json: schema: $ref: '#/components/schemas/DemoDetailError' description: Not found ("Application not found") security: - SessionCookie: [] servers: - url: https://api.platform.ankra.app components: schemas: ApplicationEnvironmentsResponse: properties: application_id: type: string title: Application Id read_state: type: string enum: - ok - unknown title: Read State read_reason: type: string title: Read Reason follows_pushes: anyOf: - type: boolean - type: 'null' latest_build: anyOf: - $ref: '#/components/schemas/ApplicationLatestBuild' - type: 'null' description: >- The newest build the platform observed on the tracked branch, the build every environment's serving.is_latest_build is measured against. null when no build was observed, its tag is blank, or it could not be read - exactly when no environment can be called the latest. environments: type: array items: $ref: '#/components/schemas/ApplicationEnvironment' title: Environments required: - application_id - read_state - read_reason - follows_pushes - latest_build - environments title: ApplicationEnvironmentsResponse type: object DemoDetailError: description: >- The FastAPI-style detail envelope the demo routes use for 400/403/404/409/502 responses. properties: detail: type: string required: - detail type: object ApplicationLatestBuild: properties: image_tag: type: string title: Image Tag description: >- The image tag the build carries; never empty. Equal to serving.image_tag on exactly the environments whose is_latest_build is true. commit_sha: anyOf: - type: string - type: 'null' description: The commit the build was made from; null when unrecorded. observed_at: anyOf: - type: string format: date-time - type: 'null' description: >- When the platform learned of the build (RFC 3339); null when unrecorded. source: anyOf: - type: string enum: - pipeline - user_ci - platform - type: 'null' description: >- What produced the build: an Ankra pipeline, the repository's own CI, or the platform builder. null when the recorded producer is one this API does not know. required: - image_tag - commit_sha - observed_at - source title: ApplicationLatestBuild type: object ApplicationEnvironment: description: >- An application environment. Assigned targets use stored identity, name, role and order across cluster placements; unassigned targets retain cluster-derived identity. Planned environments have no targets. Missing assigned placements keep status unknown. properties: id: type: string title: Id name: type: string title: Name role: type: string enum: - playground - production - staging - development - custom title: Role order: type: integer title: Order status: type: string enum: - running - degraded - failed - deploying - parked - not_deployed - unknown title: Status status_message: type: string title: Status Message follows: type: string enum: - pushes - manual - unknown title: Follows serving: anyOf: - $ref: '#/components/schemas/ApplicationEnvironmentServing' - type: 'null' address: $ref: '#/components/schemas/ApplicationEnvironmentAddress' targets: type: array items: $ref: '#/components/schemas/ApplicationEnvironmentTarget' title: Targets custom_domains: $ref: '#/components/schemas/ApplicationEnvironmentCustomDomains' required: - id - name - role - order - status - status_message - follows - serving - address - targets - custom_domains title: ApplicationEnvironment type: object ApplicationEnvironmentServing: properties: commit_sha: anyOf: - type: string - type: 'null' chart_version: anyOf: - type: string - type: 'null' image_tag: anyOf: - type: string - type: 'null' description: >- The image tag the environment's installations were deployed with; null when they carry none or disagree, never "". Known for a hand-deployed environment too, unlike commit_sha. is_latest_build: anyOf: - type: boolean - type: 'null' description: >- Whether image_tag is the newest build the platform observed on the tracked branch; null when either side is unknown. What lets the ladder say one environment is ahead of another without ranking commits it cannot order. required: - commit_sha - chart_version - image_tag - is_latest_build title: ApplicationEnvironmentServing type: object ApplicationEnvironmentAddress: properties: host: anyOf: - type: string - type: 'null' publication: anyOf: - type: string - type: 'null' required: - host - publication title: ApplicationEnvironmentAddress type: object ApplicationEnvironmentTarget: properties: cluster_id: type: string title: Cluster Id cluster_name: type: string title: Cluster Name cluster_kind: type: string title: Cluster Kind cluster_state: type: string title: Cluster State description: >- State of the cluster the target sits on (running, online, stopped, offline, ...). Omitted on draft and failed targets, which sit on no cluster yet. namespace: anyOf: - type: string - type: 'null' deployment_kind: type: string title: Deployment Kind health_status: anyOf: - type: string - type: 'null' sync_status: anyOf: - type: string - type: 'null' pod_ready: anyOf: - type: integer - type: 'null' pod_total: anyOf: - type: integer - type: 'null' installed_version: anyOf: - type: string - type: 'null' desired_version: anyOf: - type: string - type: 'null' version_drift: type: boolean title: Version Drift is_draft: type: boolean title: Is Draft is_parked: type: boolean title: Is Parked installation_status: anyOf: - type: string - type: 'null' failure_message: anyOf: - type: string - type: 'null' last_updated_at: anyOf: - type: string - type: 'null' required: - cluster_id - cluster_name - cluster_kind - namespace - deployment_kind - health_status - sync_status - pod_ready - pod_total - installed_version - desired_version - version_drift - is_draft - is_parked - installation_status - failure_message - last_updated_at title: ApplicationEnvironmentTarget type: object ApplicationEnvironmentCustomDomains: description: >- The custom domains an environment serves (ankra-y1ht0). read_state ok: every placement's deploy inputs are on record, so domains is the whole list and empty means none; partial: some placements' inputs are not on record (a hand-installed deployment, or a cluster that is unavailable), so domains may be missing some; unknown: no placement's inputs are on record, so an empty domains says nothing. certificates_read_state is not_needed with no domains, unknown when the certificate read failed. type: object properties: read_state: type: string enum: - ok - partial - unknown title: Read State certificates_read_state: type: string enum: - ok - unknown - partial - not_needed title: Certificates Read State domains: type: array items: $ref: '#/components/schemas/ApplicationCustomDomain' title: Domains required: - read_state - certificates_read_state - domains title: ApplicationEnvironmentCustomDomains ApplicationCustomDomain: description: >- One custom hostname on one placement of the environment, from the installation's stored ingress_extra_hosts deploy input. type: object properties: host: type: string title: Host cluster_id: type: string title: Cluster Id namespace: title: Namespace type: string certificate: type: string enum: - issued - pending - failed - not_requested - unknown title: Certificate description: >- issued: the cert-manager Certificate naming the host is Ready. pending: it exists and is not Ready, with nothing saying issuance failed. failed: cert-manager reports issuing failed, or it expired. not_requested: the Ingress serving the host was observed and asks for no certificate for it. unknown: nothing observed says which; never a failure. certificate_reason: type: string title: Certificate Reason certificate_observed_at: anyOf: - type: string format: date-time - type: 'null' title: Certificate Observed At description: >- When the cluster sync last saw the Certificate the verdict was read from; null when the verdict rests on no Certificate. required: - host - cluster_id - namespace - certificate - certificate_reason - certificate_observed_at title: ApplicationCustomDomain 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.