Get Agent Cluster

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

Reports total and available task slots, TaskManager count, and the Flink version of the tenant’s Flink cluster.

Agents and transforms share the same tenant Flink cluster, so this endpoint accepts either read:agents or read:transforms.

When the tenant has no Flink cluster provisioned, the response is HTTP 200 with available=false and zeroed fields rather than an error, so a client can show a “cluster not available” note.

GET/agents/cluster

Authorization

AuthorizationBearer token · headerrequired

Responses

200

Successful Response

availableboolean

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

default: true

taskmanagersinteger

Registered TaskManagers

default: 0

slotsTotalinteger

Total task slots across all TaskManagers

default: 0

slotsAvailableinteger

Idle task slots available for new deployments

default: 0

flinkVersionstring

Flink runtime version

default: "unknown"

Request

curl -X GET 'https://api.streamkap.com/agents/cluster' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.streamkap.com/agents/cluster", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/agents/cluster",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "available": true,
  "taskmanagers": 0,
  "slotsTotal": 0,
  "slotsAvailable": 0,
  "flinkVersion": "unknown"
}