Service

Set service upgrade window

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.
put/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/upgradeWindow
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service.

Request body

weekdayinteger required

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

startHourUtc0 | 6 | 12 | 18 required

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 request

{
  "weekday": 3,
  "startHourUtc": 12
}

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "weekday": 3,
    "startHourUtc": 12,
    "duration": 6
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.