Get the Gateway API status

Read where the Kubernetes Gateway API stands on this cluster: whether the cluster has Ankra-managed networking to serve it (available, with unavailable_reason when not), whether the option is recorded (enabled), the phase of the enable (off, no_platform_networking, conflict, crds_failed, crds_pending, values_pending, apply_failed, applying, enabled), the platform’s own reading of the Gateway API CRDs (where they come from, what the CRD watch sees, the gateway-api-crds addon’s state, whether they are established), what the Traefik and cert-manager values would gain, already carry or contradict (conflicts name the keys), their applied state, and why the values write is held back when it is. It is the one preview the portal, the CLI and the MCP tool render, so the three agree on what an enable would do. A cluster of another provider, or one no cloud create built, answers 409 with a detail message.

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

Get the Gateway API status

Python

import requests

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

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

response = requests.get(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>"
}

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

False when the cluster has no Ankra-managed networking to serve the Gateway API; unavailable_reason says why.

unavailable_reason · string · required

Why the Gateway API is not available on this cluster; empty when it is.

enabled · boolean · required

Whether the option is recorded on the cluster's cloud-provider definition.

phase · string · required

Where the enable stands: off, no_platform_networking, conflict, crds_failed, crds_pending, values_pending, apply_failed, applying or enabled.

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

Why the values write is held back on this cluster right now (not online, not built by Ankra, a paused GitOps sync); empty when it may go on.

resource_ids · string[] · required

The cloud-provider resource the option is recorded on.

applies · string · required

How an enable reaches the cluster.

note · string · required

What the phase means and who moves it on.