v3

latestOpenAPI 3.1.0Proprietary2026-08-07266348629.6 KB
Agents

Get Agent Cluster

Return cluster-level Flink info for the agent runtime - slots + version.

Powers the agentic dashboard header (total/available task slots, Flink version). Sourced from Flink REST /overview; kebab-case keys are translated to the camelCase response contract.

Agents and transforms share the same tenant Flink cluster, so this probe accepts either read:agents or read:transforms (OR semantics) and backs the cluster-availability note on both deploy surfaces.

When the tenant's cluster is not provisioned the upstream REST call 404s; that is reported as available=False with zeroed fields (HTTP 200) so the dashboard can render a "cluster not available" note instead of erroring.

get/agents/cluster

Response

Successful Response

availableboolean

False when the tenant's Flink cluster is not provisioned or unreachable; other fields are zeroed.

taskmanagersinteger

Registered TaskManagers

slotsTotalinteger

Total task slots across all TaskManagers

slotsAvailableinteger

Idle task slots available for new deployments

flinkVersionstring

Flink runtime version