> ## 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. # Enable the Gateway API > Turn the Kubernetes Gateway API on for this cluster. Idempotent and enable-only; the request carries no body. It records the option on the cluster's cloud-provider definition when it is not recorded yet - the platform's networking render then adds the gateway-api-crds addon within a few minutes, or uses a Gateway API CRD bundle the cluster already carries rather than installing over it - and, once the platform reads the CRDs as established, writes the Gateway API keys into the Traefik and cert-manager values through the ordinary stack write (one GitOps commit on a GitOps-backed cluster), keeping every other value the owner wrote. The values are never written while the CRDs are not up, so call it again until phase is enabled; a key the owner set the other way refuses the values write and is named under conflicts, so nothing of theirs is overwritten. Every Ingress keeps working; a Gateway is added beside them. The answer is the status after this call's writes plus what it changed (changed, recorded, values_written, commit_sha, operation_id). Invalid states answer 409 with a detail message: a cluster of another provider, one without an Ankra-managed cloud controller or networking stack, a cloud-provider resource still being created or removed, a cluster carrying only part of the Gateway API CRD bundle, one whose CRDs the platform cannot read yet, an offline cluster, and one whose GitOps sync is paused on open conflicts. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json put /api/v1/clusters/ankracloud/{cluster_id}/gateway-api 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: /api/v1/clusters/ankracloud/{cluster_id}/gateway-api: put: tags: - Ankra Cloud Clusters summary: Enable the Gateway API description: >- Turn the Kubernetes Gateway API on for this cluster. Idempotent and enable-only; the request carries no body. It records the option on the cluster's cloud-provider definition when it is not recorded yet - the platform's networking render then adds the gateway-api-crds addon within a few minutes, or uses a Gateway API CRD bundle the cluster already carries rather than installing over it - and, once the platform reads the CRDs as established, writes the Gateway API keys into the Traefik and cert-manager values through the ordinary stack write (one GitOps commit on a GitOps-backed cluster), keeping every other value the owner wrote. The values are never written while the CRDs are not up, so call it again until phase is enabled; a key the owner set the other way refuses the values write and is named under conflicts, so nothing of theirs is overwritten. Every Ingress keeps working; a Gateway is added beside them. The answer is the status after this call's writes plus what it changed (changed, recorded, values_written, commit_sha, operation_id). Invalid states answer 409 with a detail message: a cluster of another provider, one without an Ankra-managed cloud controller or networking stack, a cloud-provider resource still being created or removed, a cluster carrying only part of the Gateway API CRD bundle, one whose CRDs the platform cannot read yet, an offline cluster, and one whose GitOps sync is paused on open conflicts. operationId: >- enable_ankracloud_gateway_api_endpoint_api_v1_clusters_ankracloud__cluster_id__gateway_api_put parameters: - in: path name: cluster_id required: true schema: format: uuid title: Cluster Id type: string - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-ankra-organisation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Ankra-Organisation-Id responses: '200': content: application/json: schema: $ref: '#/components/schemas/GatewayAPIEnableResult' description: Successful Response '401': description: Unauthorized '404': description: Not found '409': description: Invalid state '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - BearerAuth: [] components: schemas: GatewayAPIEnableResult: properties: available: title: Available type: boolean description: As GatewayAPIStatus. unavailable_reason: title: Unavailable Reason type: string description: As GatewayAPIStatus. enabled: title: Enabled type: boolean description: As GatewayAPIStatus. phase: title: Phase type: string description: As GatewayAPIStatus, after this call's writes. crds: $ref: '#/components/schemas/GatewayAPICRDsStatus' traefik: $ref: '#/components/schemas/GatewayAPIMemberStatus' cert_manager: $ref: '#/components/schemas/GatewayAPIMemberStatus' values_hold: title: Values Hold type: string description: As GatewayAPIStatus. resource_ids: items: type: string title: Resource Ids type: array description: As GatewayAPIStatus. applies: title: Applies type: string description: As GatewayAPIStatus. note: title: Note type: string description: As GatewayAPIStatus. changed: title: Changed type: boolean description: 'True when this call wrote anything: the record, the values, or both.' recorded: title: Recorded type: boolean description: >- True when this call turned the option on in the cloud-provider definition. values_written: title: Values Written type: boolean description: >- True when this call wrote the Gateway API keys into the Traefik and cert-manager values. commit_sha: anyOf: - type: string - type: 'null' title: Commit Sha description: >- The GitOps commit the values write made, when the cluster is GitOps-backed and the push succeeded. operation_id: anyOf: - type: string - type: 'null' title: Operation Id description: The operation the values write started, when it started one. git_push_failure: anyOf: - type: string - type: 'null' title: Git Push Failure description: >- Set when the values reached the database but the GitOps push failed or was deferred; the stack write's own wording. required: - available - unavailable_reason - enabled - phase - crds - traefik - cert_manager - values_hold - resource_ids - applies - note - changed - recorded - values_written - commit_sha - operation_id - git_push_failure title: GatewayAPIEnableResult type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object GatewayAPICRDsStatus: properties: source: title: Source type: string description: >- Where the CRDs come from once the option is recorded: addon or preinstalled; empty while the option is off. state: title: State type: string description: >- What the CustomResourceDefinition watch sees: present, absent, incomplete or unknown. Unknown is never absent. observed: items: type: string title: Observed type: array description: The Gateway API CRDs the watch has seen on the cluster. missing: items: type: string title: Missing type: array description: >- The Gateway API CRDs the watch has not seen; meaningful with an authoritative watch or a partial bundle. addon_state: anyOf: - type: string - type: 'null' title: Addon State description: >- The gateway-api-crds addon's resource state; null when the cluster carries no such addon yet. addon_applied: title: Addon Applied type: string description: >- The addon's applied-state reading: applied, pending, failed or unknown. established: title: Established type: boolean description: >- Whether the Traefik and cert-manager values may be written: the addon is up with no failed apply and the watch does not contradict it, or a preinstalled bundle is fully seen. detail: title: Detail type: string description: What the reading means, in a sentence. required: - source - state - observed - missing - addon_state - addon_applied - established - detail title: GatewayAPICRDsStatus type: object GatewayAPIMemberStatus: properties: addon: title: Addon type: string description: traefik or cert-manager. managed: title: Managed type: boolean description: >- False when the cluster's networking stack carries no such member on the platform's chart; nothing is written then. values: title: Values type: string description: >- What the member's stored values say about the option: add (the keys are still to be written), already_on, conflict, or unmanaged. conflicts: items: $ref: '#/components/schemas/GatewayAPIFinding' title: Conflicts type: array description: The keys whose stored value contradicts the option; empty when none. applied: title: Applied type: string description: >- The member's applied-state reading: applied, pending, failed or unknown. last_applied_at: anyOf: - type: string - type: 'null' title: Last Applied At description: >- When the member's stored configuration was last applied, RFC 3339; null when the platform holds no record. required: - addon - managed - values - conflicts - applied - last_applied_at title: GatewayAPIMemberStatus 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 GatewayAPIFinding: properties: addon: title: Addon type: string description: 'The member the finding is on: traefik or cert-manager.' key: title: Key type: string description: The dotted values key the finding is about. outcome: title: Outcome type: string description: add, already_on or conflict. detail: title: Detail type: string description: For a conflict, what the owner's values say at the key. required: - addon - key - outcome - detail title: GatewayAPIFinding type: object securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.