import requests
url = "https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api \
--header 'Authorization: Bearer <token>'{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get the Gateway API status of a Proxmox VE cluster
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.
import requests
url = "https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://platform.ankra.app/api/v1/clusters/proxmox/{cluster_id}/gateway-api \
--header 'Authorization: Bearer <token>'{
"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>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
False when the cluster has no Ankra-managed networking to serve the Gateway API; unavailable_reason says why.
Why the Gateway API is not available on this cluster; empty when it is.
Whether the option is recorded on the cluster's cloud-provider definition.
Where the enable stands: off, no_platform_networking, conflict, crds_failed, crds_pending, values_pending, apply_failed, applying or enabled.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
The cloud-provider resource the option is recorded on.
How an enable reaches the cluster.
What the phase means and who moves it on.