ClickHouse Cloud: Clickhouse Postgres Service Set Password

Set a new superuser password for a ClickHouse Cloud Postgres service.

Tool ID: clickhouse_postgres_service_set_password

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_postgres_service_set_password',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "postgresId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clickhouse_postgres_service_set_password --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000",
  "postgresId": "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": {
      "password": "YOUR_PASSWORD"
    }
  }
}

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

Input reference

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future. Sets a new password for a Postgres service’s superuser account.

Name	Type	Required	Default	Details
`payload.organizationId`	`string`	Yes	—	ID of the organization that owns the Postgres service. Format: `uuid`.
`payload.postgresId`	`string`	Yes	—	ID of the requested Postgres service. Format: `uuid`.
`payload.password`	`string`	No	—	Optional password. If not provided a new password is generated and provided in the response. Must contain: * At least one lowercase letter * At least one uppercase letter * At least one digit Minimum length: 12. Maximum length: 1024. Pattern: `^(?=.[a-z])(?=.[A-Z])(?=.[0-9]).$`.

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.password`	`string`	No	—	New Postgres superuser password. Provided only if there was no ‘password’ in the request.
`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