> ## Documentation Index > Fetch the complete documentation index at: https://deepline.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # ClickHouse Cloud: Clickhouse Upgrade Window Update > Set the weekday and UTC start hour of a ClickHouse Cloud service's weekly upgrade window. Includes inputs, outputs, SDK V2 examples, and Deepline cost. Set the weekday and UTC start hour of a ClickHouse Cloud service's weekly upgrade window. > [!NOTE] > > Tool ID: `clickhouse_upgrade_window_update` ## Run this action Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing. ```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} import { Deepline } from 'deepline'; const deepline = await Deepline.connect(); const result = await deepline.tools.execute( 'clickhouse_upgrade_window_update', { "organizationId": "123e4567-e89b-42d3-a456-426614174000", "serviceId": "123e4567-e89b-42d3-a456-426614174000", "weekday": 6, "startHourUtc": 0 }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} deepline tools execute clickhouse_upgrade_window_update --input '{ "organizationId": "123e4567-e89b-42d3-a456-426614174000", "serviceId": "123e4567-e89b-42d3-a456-426614174000", "weekday": 6, "startHourUtc": 0 }' --json ``` ## Example response The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response. ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "data": { "status": 123, "requestId": "123e4567-e89b-42d3-a456-426614174000", "result": { "weekday": 6, "startHourUtc": 0, "duration": 6 } } } ``` Use `deepline describe clickhouse_upgrade_window_update --json` for the latest machine-readable contract. ## Input reference 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. | Name | Type | Required | Default | Details | | - | - | - | - | - | | `payload.organizationId` | `string` | Yes | — | ID of the organization that owns the service. Format: `uuid`. | | `payload.serviceId` | `string` | Yes | — | ID of the service. Format: `uuid`. | | `payload.weekday` | `integer` | Yes | — | Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday. Minimum: 0. Maximum: 6. | | `payload.startHourUtc` | `0 \| 6 \| 12 \| 18` | Yes | — | 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. Allowed: `0`, `6`, `12`, `18`. |
Show raw input schema ### Input JSON Schema ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "type": "object", "description": "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.", "properties": { "organizationId": { "type": "string", "description": "ID of the organization that owns the service.", "format": "uuid" }, "serviceId": { "type": "string", "description": "ID of the service.", "format": "uuid" }, "weekday": { "type": "integer", "description": "Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday.", "minimum": 0, "maximum": 6 }, "startHourUtc": { "type": "integer", "description": "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.", "enum": [ 0, 6, 12, 18 ] } }, "required": [ "organizationId", "serviceId", "weekday", "startHourUtc" ], "additionalProperties": false } ```
## Output reference Standard tool result payload. | Name | Type | Required | Default | Details | | - | - | - | - | - | | `result.data` | `object` | Yes | — | Provider response payload. | | `result.data.status` | `number` | No | — | HTTP status code. | | `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. | | `result.data.result` | `object` | No | — | — | | `result.data.result.weekday` | `integer` | Yes | — | Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday. Minimum: 0. Maximum: 6. | | `result.data.result.startHourUtc` | `0 \| 6 \| 12 \| 18` | Yes | — | UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18. Allowed: `0`, `6`, `12`, `18`. | | `result.data.result.duration` | `6` | Yes | — | Length of the upgrade window in hours. Currently only a 6-hour window is supported. Allowed: `6`. | | `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema ### Output JSON Schema ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "type": "object", "description": "Standard tool result payload.", "properties": { "data": { "type": "object", "description": "Provider response payload.", "properties": { "status": { "type": "number", "description": "HTTP status code." }, "requestId": { "type": "string", "description": "Unique id assigned to every request. UUIDv4", "format": "uuid" }, "result": { "properties": { "weekday": { "type": "integer", "description": "Day of the week the upgrade window starts. 0 = Sunday, 1 = Monday, …, 6 = Saturday.", "minimum": 0, "maximum": 6 }, "startHourUtc": { "type": "integer", "description": "UTC hour when the upgrade window starts. Must be one of 0, 6, 12, or 18.", "enum": [ 0, 6, 12, 18 ] }, "duration": { "type": "integer", "description": "Length of the upgrade window in hours. Currently only a 6-hour window is supported.", "enum": [ 6 ] } }, "required": [ "weekday", "startHourUtc", "duration" ], "additionalProperties": false } }, "additionalProperties": false }, "meta": { "type": "object", "description": "Additional response metadata (status, paging).", "additionalProperties": true } }, "required": [ "data" ], "additionalProperties": false } ```
## Deepline cost * Pricing model: `fixed` (per call). * Estimated Deepline credits: `0` per pricing unit. * Provider-native pricing may still exist outside Deepline credit billing. ## Related documentation * [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md) * [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md) * [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md) * [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.