Skip to content

Set the cluster maintenance window

PUT
/clusters/{cluster_id}/maintenance-window
curl --request PUT \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/maintenance-window \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "days_of_week": [ 1 ], "start_local": "example", "end_local": "example", "timezone": "example" }'

Creates or replaces the cluster’s maintenance window.

Required scope: clusters:write

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
API-Version
required
string
Allowed values: 2026-06-01.beta

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A cluster maintenance window: when Skycloak applies upgrades and other disruptive changes.

object
enabled
required

Whether the window is active.

boolean
days_of_week
required

Days of week the window applies to (0 = Sunday … 6 = Saturday).

Array<integer>
start_local
required

Local start time, HH:MM.

string
end_local
required

Local end time, HH:MM.

string
timezone
required

IANA timezone, e.g. Europe/Berlin.

string

Example generated

{
  "enabled": true,
  "days_of_week": [
    1
  ],
  "start_local": "example",
  "end_local": "example",
  "timezone": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The request has succeeded.

Media typeapplication/json

A cluster maintenance window: when Skycloak applies upgrades and other disruptive changes.

object
enabled
required

Whether the window is active.

boolean
days_of_week
required

Days of week the window applies to (0 = Sunday … 6 = Saturday).

Array<integer>
start_local
required

Local start time, HH:MM.

string
end_local
required

Local end time, HH:MM.

string
timezone
required

IANA timezone, e.g. Europe/Berlin.

string

Example generated

{
  "enabled": true,
  "days_of_week": [
    1
  ],
  "start_local": "example",
  "end_local": "example",
  "timezone": "example"
}

401

Section titled “401”

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

Section titled “404”

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

422

Section titled “422”

Client error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
errors
required
Array<object>
>= 1 items
object
field
required
string
detail
required
string
code
string
value

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "errors": [
    {
      "field": "example",
      "detail": "example",
      "code": "example",
      "value": "example"
    }
  ]
}

429

Section titled “429”

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Section titled “Headers”
Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer

500

Section titled “500”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Section titled “501”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}
© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.