Set service upgrade window | ClickHouse Docs

PUT/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

Creates or fully replaces the upgrade window for a service. The upgrade window currently lasts 6 hours from startHourUtc. The upgrade window can only be set on primary services; secondary services inherit the primary service window.

Errors:

400: invalid field values (weekday not in 0–6, startHourUtc not in {0, 6, 12, 18}), or the service is a secondary service.
401: missing, invalid, or disabled API key.
403: caller lacks control-plane:service:manage on the service, or the organization does not have the scheduled upgrades feature enabled.
404: service does not exist or is not visible to the caller.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the service.

format: uuid

Request bodyJSON

weekdayintegerrequired
Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday.

maximum: 6, minimum: 0
Example: 3
startHourUtc0or6or12or18required
UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18. The upgrade window currently lasts 6 hours from this start time.

Example: 12

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
3 properties
- weekdayintegerrequired
  Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday.
  
  maximum: 6, minimum: 0
  Example: 3
- startHourUtc0or6or12or18required
  UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18.
  
  Example: 12
- duration6required
  Length of the upgrade window in hours. Currently only a 6-hour window is supported.
  
  Example: 6

Set service upgrade window

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "weekday": 3,
  "startHourUtc": 12
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({weekday: 3, startHourUtc: 12})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/upgradeWindow"

payload = {
    "weekday": 3,
    "startHourUtc": 12
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "weekday": 3,
    "startHourUtc": 12,
    "duration": 6
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}