ClickHouse Cloud: Clickhouse Backup Configuration Update

Change a ClickHouse Cloud service’s backup schedule: backup period, retention period and start time.

Tool ID: clickhouse_backup_configuration_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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_backup_configuration_update',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "serviceId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_backup_configuration_update --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "serviceId": "123e4567-e89b-42d3-a456-426614174000"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "backupPeriodInHours": 123,
      "backupRetentionPeriodInHours": 123,
      "backupStartTime": "example"
    }
  }
}

Use deepline describe clickhouse_backup_configuration_update --json for the latest machine-readable contract.

Input reference

Updates service backup configuration. Requires ADMIN auth key role. Setting the properties with null value, will reset the properties to theirs default values.

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.backupPeriodInHours`	`number`	No	—	The interval in hours between each backup.
`payload.backupRetentionPeriodInHours`	`number`	No	—	The minimum duration in hours for which the backups are available. Must be a whole number of days between 24 (1 day) and 1080 (45 days) — i.e. a multiple of 24.
`payload.backupStartTime`	`string`	No	—	The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.

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.backupPeriodInHours`	`number`	No	—	The interval in hours between each backup.
`result.data.result.backupRetentionPeriodInHours`	`number`	No	—	The minimum duration in hours for which the backups are available. Must be a whole number of days between 24 (1 day) and 1080 (45 days) — i.e. a multiple of 24.
`result.data.result.backupStartTime`	`string`	No	—	The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation