Skip to content
Documentation

Update Cluster (Observability)

v2
OpenAPI 3.1.0

ClusterNest API

To get started, generate an access token via the POST /auth/token endpoint below. Afterwards include the token as Bearer in the Authorization header of all requests. e.g. Authorization: Bearer <your_access_token>.

Server:https://api.clusternest.com
Client Libraries

observability

​

Update Cluster

​

Path Parameters

  • Integer numbers.

Body·ObservabilityUpdate

required
application/json
  • Identity providers that may sign in to the UI. Replaces the current list, so include every source you want to keep. Secret values are write-only: omit one to keep the stored value.

  • Custom domain to serve the UI on, instead of the generated default hostname.

  • IP addresses or subnets allowed to reach the UI

  • Weekly recurring window (UTC) during which maintenance may be performed on this cluster. Must be at least 2 hours (120 minutes) long. Leave unset to allow maintenance at any time.

    Properties: 3
  • Custom domain to serve the collector endpoint on, instead of the generated default hostname.

  • IP addresses or subnets allowed to send data to the collector endpoint

  • How long logs, traces, metrics and sessions are retained before being deleted. The following optional suffixes are supported: h (hour), d (day), w (week), y (year). If suffix isn't set, then the duration is counted in months. A year counts as 365 days and a month as 30 days. Lowering it frees disk space gradually, as data already stored ages out under the previous period.

  • Sizing/pricing tier the cluster runs at.

  • ClickStack version to run.

Responses

  • application/json
  • application/json
Request Example for put/cluster/observability/{cluster_id}
curl 'https://api.clusternest.com/cluster/observability/{cluster_id}' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "tier": "basic",
  "maintenance_window": {
    "day_of_week": "monday",
    "start_time": "",
    "end_time": ""
  },
  "version": "2.43.1",
  "ip_allowlist": [
    "0.0.0.0/0",
    "::/0"
  ],
  "otel_ip_allowlist": [
    "0.0.0.0/0",
    "::/0"
  ],
  "retention_period": "30d",
  "custom_hostname": "",
  "otel_custom_hostname": "",
  "auth_sources": []
}'
{
  "id": 1,
  "organization_id": 1,
  "name": "string",
  "tier": "basic",
  "state": "creating",
  "created_at": "2026-11-19T08:05:38.948Z",
  "updated_at": "2026-11-19T08:05:38.948Z",
  "maintenance_window": {
    "day_of_week": "monday",
    "start_time": "string",
    "end_time": "string"
  },
  "version": "2.43.1",
  "url": "string",
  "otel_url": "string",
  "custom_hostname": "string",
  "otel_custom_hostname": "string",
  "ip_allowlist": [
    "0.0.0.0/0",
    "::/0"
  ],
  "otel_ip_allowlist": [
    "0.0.0.0/0",
    "::/0"
  ],
  "retention_period": "30d",
  "auth_sources": [
    {
      "name": "string",
      "roles_key": "string",
      "roles_map": {
        "additionalProperty": "string"
      },
      "type": "oidc",
      "issuer_url": "string",
      "client_id": "string",
      "client_secret_set": false,
      "scope": "openid email profile"
    }
  ]
}