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.

PUT /api/v1/clusters/ankracloud/{cluster_id}/gateway-api

Enable the Gateway API

Python

import requests

url = "https://platform.ankra.app/api/v1/clusters/ankracloud/{cluster_id}/gateway-api"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)

200

{
  "available": true,
  "unavailable_reason": "<string>",
  "enabled": true,
  "phase": "<string>",
  "crds": {
    "source": "<string>",
    "state": "<string>",
    "observed": [
      "<string>"
    ],
    "missing": [
      "<string>"
    ],
    "addon_state": "<string>",
    "addon_applied": "<string>",
    "established": true,
    "detail": "<string>"
  },
  "traefik": {
    "addon": "<string>",
    "managed": true,
    "values": "<string>",
    "conflicts": [
      {
        "addon": "<string>",
        "key": "<string>",
        "outcome": "<string>",
        "detail": "<string>"
      }
    ],
    "applied": "<string>",
    "last_applied_at": "<string>"
  },
  "cert_manager": {
    "addon": "<string>",
    "managed": true,
    "values": "<string>",
    "conflicts": [
      {
        "addon": "<string>",
        "key": "<string>",
        "outcome": "<string>",
        "detail": "<string>"
      }
    ],
    "applied": "<string>",
    "last_applied_at": "<string>"
  },
  "values_hold": "<string>",
  "resource_ids": [
    "<string>"
  ],
  "applies": "<string>",
  "note": "<string>",
  "changed": true,
  "recorded": true,
  "values_written": true,
  "commit_sha": "<string>",
  "operation_id": "<string>",
  "git_push_failure": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

cluster_id · string<uuid> · required

Response

200

application/json

Successful Response

available · boolean · required

As GatewayAPIStatus.

unavailable_reason · string · required

As GatewayAPIStatus.

enabled · boolean · required

As GatewayAPIStatus.

phase · string · required

As GatewayAPIStatus, after this call's writes.

crds · GatewayAPICRDsStatus · object · required

Show child attributes

traefik · GatewayAPIMemberStatus · object · required

Show child attributes

cert_manager · GatewayAPIMemberStatus · object · required

Show child attributes

values_hold · string · required

As GatewayAPIStatus.

resource_ids · string[] · required

As GatewayAPIStatus.

applies · string · required

As GatewayAPIStatus.

note · string · required

As GatewayAPIStatus.

changed · boolean · required

True when this call wrote anything: the record, the values, or both.

recorded · boolean · required

True when this call turned the option on in the cloud-provider definition.

values_written · boolean · required

True when this call wrote the Gateway API keys into the Traefik and cert-manager values.

commit_sha · string | null · required

The GitOps commit the values write made, when the cluster is GitOps-backed and the push succeeded.

operation_id · string | null · required

The operation the values write started, when it started one.

git_push_failure · string | null · required

Set when the values reached the database but the GitOps push failed or was deferred; the stack write's own wording.