Retrieve detailed configuration and status of a specific cluster

Request

Security

JWTAuthorizer

Path

clusterFQDNstringrequired

Cluster FQDN

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/cluster/{clusterFQDN}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

configobject

Cluster-wide configuration. Mirrors the subset of node configuration sections that are shared across cluster members. Use the /cluster/{clusterFQDN}/config/* endpoints to modify individual sections rather than editing this object directly.

domainstring

Cluster domain

fqdnstring

Cluster FQDN

healthstring

Cluster health

Enum:"healthy""unhealthy""offline""unknown"

modestring

Cluster Failback Mode

Enum:"autoFailback""manualFailback"

namestring

Cluster name

orgstring

Organization ID (UUID) that owns this cluster

tagsobject

User-defined tags for organizing and filtering clusters

tgTagsobject

System-managed tags assigned by the Trustgrid platform (read-only)

tgrnstring

Trustgrid Resource Name for this cluster. Format: tgrn:tg::nodes:cluster/{fqdn}

Example:"tgrn:tg::nodes:cluster/mycluster.myorg.trustgrid.io"

created_atinteger

Unix timestamp (seconds) when the cluster was created

lifecycleStatestring

Operational lifecycle state of the cluster

Enum:"pre-production""production""maintenance""decommissioned"

Response

{
  "config": {
    "exec": { … },
    "vpn": { … },
    "network": { … },
    "services": { … },
    "connectors": { … },
    "apigw": {},
    "core": {}
  },
  "domain": "string",
  "fqdn": "string",
  "health": "healthy",
  "mode": "autoFailback",
  "name": "string",
  "org": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "tgTags": {
    "property1": "string",
    "property2": "string"
  },
  "tgrn": "tgrn:tg::nodes:cluster/mycluster.myorg.trustgrid.io",
  "created_at": 0,
  "lifecycleState": "pre-production"
}