openapi: 3.2.0 info: title: OpenAPI spec for ClickHouse Cloud Postgres API version: '1.0' contact: name: ClickHouse Support url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336 email: support@clickhouse.com servers: - url: https://api.clickhouse.cloud security: - basicAuth: [] tags: - name: Postgres paths: /v1/organizations/{organizationId}/postgres: post: summary: Create new Postgres service description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Creates a new Postgres service in the organization and returns it. The service is started asynchronously.' operationId: postgresServiceCreate parameters: - in: path name: organizationId description: ID of the organization that will own the service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServicePostRequest' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after get: summary: List of organization Postgres services description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a list of all Postgres services in the organization.' operationId: postgresServiceGetList parameters: - in: path name: organizationId description: ID of the organization that owns the services. required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: type: array items: $ref: '#/components/schemas/PostgresServiceListItem' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}: get: summary: Get PostgreSQL service details description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns a Postgres service that belongs to the organization' operationId: postgresServiceGet parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after delete: summary: Delete a PostgreSQL service description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Deletes a Postgres service that belongs to the organization' operationId: postgresServiceDelete parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after patch: summary: Update a PostgreSQL service description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update a Postgres service that belongs to the organization. **WARNING:** Changing the name also updates the host name and certificates for the service.' operationId: postgresServicePatch parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServicePatchRequest' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/caCertificates: get: summary: Get Postgres CA certs description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Download CA certificates for a PostgreSQL service' operationId: postgresServiceCertsGet parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid responses: '200': description: Successful response headers: Content-Disposition: schema: type: string example: attachment; filename="postgres-ca-certificate.pem" content: application/x-pem-file: schema: type: string '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/restoredService: post: summary: Restore a Postgres service description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Restore a Postgres database from continuous backup, optionally at a specific point in time.' operationId: postgresInstanceRestore parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServiceRestoreRequest' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/password: patch: summary: Update Postgres superuser password description: '**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.' operationId: postgresServiceSetPassword parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServiceSetPassword' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresServicePasswordResource' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/state: patch: summary: Update Postgres service state description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate a process for a Postgres service: * restart: Initiates a service restart * promote: Promotes a read replica to primary * switchover: Switch a primary over to a standby' operationId: postgresServicePatchState parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServiceSetState' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/readReplica: post: summary: Create a read replica for a Postgres service description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Initiate the process to create a new read replica for a Postgres service.' operationId: postgresInstanceCreateReadReplica parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/PostgresServiceReadReplicaRequest' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresService' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/config: get: summary: Get PostgreSQL service configuration description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns the configuration data for a Postgres service and its PgBouncer service.' operationId: postgresInstanceConfigGet parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/postgresInstanceConfig' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after post: summary: Replace Postgres service configuration description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Replace the existing Postgres service and pgBouncer configuration.' operationId: postgresInstanceConfigPost parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/postgresInstanceConfig' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/postgresInstanceUpdateConfigResponse' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after patch: summary: Update Postgres service configuration description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Update the existing Postgres service and pgBouncer configuration.' operationId: postgresInstanceConfigPatch parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/postgresInstanceConfig' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/postgresInstanceUpdateConfigResponse' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/metrics: get: summary: Get Postgres time-series metrics description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns bucketed time-series metrics for a PostgreSQL service over the requested window (CPU, memory, disk, network, connections, cache hit ratio, throughput, transactions, and more). Use this to chart or analyze how a service behaved over time.' operationId: postgresInstanceMetricsGet parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the Postgres service. required: true schema: type: string format: uuid - in: query name: from_date description: Inclusive start of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: to_date description: Exclusive end of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: bucket_size_seconds description: Time-series bucket size in seconds. When omitted, a bucket size is derived from the requested window. Requests are capped at 250 data points. schema: type: integer minimum: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresMetrics' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns: get: summary: List Postgres slow query patterns description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for the slowest query patterns observed on a Postgres service during the given time window. Use this to discover which queries dominate total execution time, CPU, I/O, or WAL generation.' operationId: slowQueryPatternsGetList parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid - in: query name: from_date description: Inclusive start of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: to_date description: Exclusive end of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: db_name description: Database name filter. schema: type: string - in: query name: db_user description: Database user filter. schema: type: string - in: query name: db_operation description: Database operation filter (for example, SELECT, INSERT, UPDATE, DELETE, UTILITY). schema: type: string - in: query name: app description: Application name filter. schema: type: string - in: query name: sort_by description: Field to sort results by. schema: type: string enum: - total_duration - avg_duration - call_count - total_blks_read - total_cpu_time - error_count - max_duration - p50_duration - p95_duration - p99_duration - total_rows - total_shared_blks_hit - total_wal_bytes default: total_duration - in: query name: sort_order description: Sort order. One of `asc` or `desc`. schema: type: string enum: - asc - desc default: desc - in: query name: limit description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 500 default: 20 - in: query name: offset description: Number of results to skip before returning. schema: type: integer minimum: 0 default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: type: array items: $ref: '#/components/schemas/PostgresSlowQueryPattern' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns/{queryId}: get: summary: Get a Postgres slow query pattern with recent executions description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns aggregate metrics for a single slow query pattern together with its most recent individual executions.' operationId: slowQueryPatternGet parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid - in: path name: queryId description: Stable identifier for the query pattern. required: true schema: type: string - in: query name: db_name description: Database name filter. schema: type: string required: true - in: query name: db_user description: Database user filter. schema: type: string required: true - in: query name: db_operation description: Database operation filter (for example, SELECT, INSERT, UPDATE, DELETE, UTILITY). schema: type: string required: true - in: query name: app description: Application name filter. schema: type: string - in: query name: timestamp description: Timestamp of a specific execution (RFC 3339). schema: type: string format: date-time responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: $ref: '#/components/schemas/PostgresSlowQueryPatternDetail' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after /v1/organizations/{organizationId}/postgres/{postgresId}/logs: get: summary: List Postgres server logs description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. Returns PostgreSQL server log entries for a Postgres service within the given time window, most recent first by default (override with `sort_order`). Results are paginated with `limit`/`offset`; advance `offset` until a page returns fewer than `limit` entries to read the full window. The time range must not exceed 30 days, and `to_date` must be after `from_date`.' operationId: postgresLogsGetList parameters: - in: path name: organizationId description: ID of the organization that owns the Postgres service. required: true schema: type: string format: uuid - in: path name: postgresId description: ID of the requested Postgres service. required: true schema: type: string format: uuid - in: query name: from_date description: Inclusive start of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: to_date description: Inclusive end of the time window (RFC 3339 date-time). schema: type: string format: date-time required: true - in: query name: body_contains description: Case-sensitive substring the log body must contain. schema: type: string - in: query name: severity description: Filter to log entries with this PostgreSQL severity (for example, ERROR, WARNING, LOG). schema: type: string - in: query name: sort_order description: Sort order. One of `asc` or `desc`. schema: type: string enum: - asc - desc default: desc - in: query name: limit description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 2000 default: 50 - in: query name: offset description: Number of results to skip before returning. schema: type: integer minimum: 0 default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 200 requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid result: type: array items: $ref: '#/components/schemas/PostgresLogEntry' '400': description: The request cannot be processed due to a client error. Please verify your request parameters and try again. content: application/json: schema: type: object properties: status: type: number description: HTTP status code. example: 400 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid '500': description: An internal server error has occurred. If this issue persists, please contact ClickHouse Cloud support for assistance. content: application/json: schema: type: object properties: status: type: integer description: HTTP status code. example: 500 error: type: string description: Detailed error description. requestId: type: string description: Unique id assigned to every request. UUIDv4 format: uuid tags: - Postgres x-badges: - name: Beta position: after components: schemas: PostgresServiceListItem: properties: name: $ref: '#/components/schemas/pgNameProperty' provider: $ref: '#/components/schemas/pgProvider' region: $ref: '#/components/schemas/pgRegion' postgresVersion: $ref: '#/components/schemas/pgVersion' size: $ref: '#/components/schemas/pgSize' haType: $ref: '#/components/schemas/pgHaType' tags: $ref: '#/components/schemas/pgTags' id: $ref: '#/components/schemas/pgIdProperty' state: $ref: '#/components/schemas/pgStateProperty' createdAt: $ref: '#/components/schemas/pgCreatedAtProperty' isPrimary: $ref: '#/components/schemas/pgIsPrimaryProperty' PostgresSlowQueryPatternDetail: properties: aggregate: $ref: '#/components/schemas/PostgresSlowQueryPattern' recentExecutions: type: array description: Recent individual executions matching the pattern. items: $ref: '#/components/schemas/PostgresQueryExecution' required: - recentExecutions pgIdProperty: type: string title: Unique Postgres service ID format: uuid example: f71df78e-ddad-82d0-8dfa-abbec741b82e pgProvider: type: string enum: - aws - gcp title: Cloud provider description: The cloud provider for a Postgres service. pgRegion: type: string title: Service region description: The cloud region for a Postgres service. ResourceTagsV1: type: object properties: key: type: string description: Tag key. Must be alphanumeric with dashes, underscores and dots. minLength: 1 maxLength: 128 pattern: ^[a-zA-Z0-9._-]+$ value: type: string description: Tag value. Must be alphanumeric with dashes, underscores and dots. maxLength: 256 pattern: ^[a-zA-Z0-9._-]+$ required: - key example: key: Environment value: staging pgConfig: type: object title: Postgres Configuration description: Postgres [runtime configuration](https://www.postgresql.org/docs/current/runtime-config.html) configuration. properties: max_connections: type: - string - integer description: Sets the maximum number of concurrent connections to the database server. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_connections/ example: 500 minimum: 1 default_transaction_isolation: type: string description: Sets the default transaction isolation level for new transactions. externalDocs: url: https://postgresqlco.nf/doc/en/param/default_transaction_isolation/ example: read committed enum: - read committed - repeatable read - serializable ssl_min_protocol_version: type: string description: Sets the minimum SSL/TLS protocol version allowed for client connections. externalDocs: url: https://postgresqlco.nf/doc/en/param/ssl_min_protocol_version/ example: TLSv1.3 enum: - TLSv1 - TLSv1.1 - TLSv1.2 - TLSv1.3 maintenance_work_mem: type: - string - integer description: Sets the maximum memory to be used for maintenance operations. externalDocs: url: https://postgresqlco.nf/doc/en/param/maintenance_work_mem/ example: 64MB minimum: 64 work_mem: type: - string - integer description: Sets the amount of memory Postgres will use for internal operations like sorting and hashing as part of executing a query. externalDocs: url: https://postgresqlco.nf/doc/en/param/work_mem/ example: 4MB minimum: 64 effective_cache_size: type: - string - integer description: Sets the planner's assumption about the total size of data caches. externalDocs: url: https://postgresqlco.nf/doc/en/param/effective_cache_size/ example: 4GB minimum: 8 random_page_cost: type: - string - number description: Sets the planner's estimate of the cost of a non-sequentially-fetched disk page. Lower values (1.1-1.5) are better for SSDs. externalDocs: url: https://postgresqlco.nf/doc/en/param/random_page_cost/ example: 1.1 minimum: 0 effective_io_concurrency: type: - string - integer description: Number of concurrent disk I/O operations the planner expects. Higher values (100-200) benefit SSDs. externalDocs: url: https://postgresqlco.nf/doc/en/param/effective_io_concurrency/ example: 200 minimum: 0 max_worker_processes: type: - string - integer description: Maximum number of background processes the system can support. Includes parallel query workers, logical replication, and more. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_worker_processes/ example: 8 minimum: 0 max_parallel_workers: type: - string - integer description: Maximum number of workers that can be used for parallel operations. Cannot exceed max_worker_processes. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_parallel_workers/ example: 4 minimum: 0 max_parallel_workers_per_gather: type: - string - integer description: Maximum number of parallel workers per executor node for parallel queries. Use 0 to disable parallel queries. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_parallel_workers_per_gather/ example: 2 minimum: 0 max_parallel_maintenance_workers: type: - string - integer description: Maximum number of parallel workers for maintenance operations like CREATE INDEX and VACUUM. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_parallel_maintenance_workers/ example: 2 minimum: 0 statement_timeout: type: - string - integer description: Abort any statement that runs longer than the specified time. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/statement_timeout/ example: 60s minimum: 0 lock_timeout: type: - string - integer description: Abort any statement that waits longer than the specified time while attempting to acquire a lock. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/lock_timeout/ example: 10s minimum: 0 idle_session_timeout: type: - string - integer description: Terminate any session that has been idle for longer than the specified time. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/idle_session_timeout/ example: 2m minimum: 0 idle_in_transaction_session_timeout: type: - string - integer description: Terminate any session that has been idle within an open transaction for longer than the specified time. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/idle_in_transaction_session_timeout/ example: 2h minimum: 0 transaction_timeout: type: - string - integer description: Terminate any statement that takes more than the specified time, even while active. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/transaction_timeout/ example: 120s minimum: 0 wal_sender_timeout: type: - string - integer description: Terminate replication connections that are inactive for longer than this time. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/wal_sender_timeout/ example: 120m minimum: 0 wal_keep_size: type: - string - integer description: Minimum size of past WAL files kept in pg_wal for standby servers. Use 0 to disable. externalDocs: url: https://postgresqlco.nf/doc/en/param/wal_keep_size/ example: 1GB minimum: 0 min_wal_size: type: - string - integer description: Minimum size to shrink the WAL to. WAL files are recycled rather than removed when below this size. externalDocs: url: https://postgresqlco.nf/doc/en/param/min_wal_size/ example: 80MB minimum: 32768 max_wal_size: type: - string - integer description: Maximum size WAL can grow between checkpoints. Larger values improve write performance but increase crash recovery time. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_wal_size/ example: 5GB minimum: 32768 max_slot_wal_keep_size: type: - string - integer description: Specifies the maximum size of WAL files that replication slots are allowed to retain. Use -1 for unlimited. externalDocs: url: https://postgresqlco.nf/doc/en/param/max_slot_wal_keep_size/ example: '-1' minimum: 0 wal_compression: type: string description: Compress full-page writes in WAL. Reduces I/O at the cost of CPU. Options vary by PostgreSQL version. externalDocs: url: https://postgresqlco.nf/doc/en/param/wal_compression/ example: 'off' enum: - 'off' - 'on' - lz4 - zstd autovacuum_max_workers: type: - string - integer description: Maximum number of autovacuum worker processes that can run at the same time. Workers share a single cost-limit budget, so raising this alone may not speed up vacuuming. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_max_workers/ example: 8 minimum: 1 autovacuum_naptime: type: - string - integer description: Minimum delay between autovacuum runs. Lower values make autovacuum check for work more frequently. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_naptime/ example: 5s minimum: 1 autovacuum_work_mem: type: - string - integer description: Maximum memory each autovacuum worker uses to track dead tuples. Higher values reduce repeated index-vacuum passes on large tables. Use -1 to fall back to maintenance_work_mem. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_work_mem/ example: 64000kB minimum: 1024 autovacuum_vacuum_scale_factor: type: - string - number description: Fraction of a table's rows that must change before autovacuum runs. Lower values vacuum large tables more frequently. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_vacuum_scale_factor/ example: 0.2 minimum: 0 autovacuum_analyze_scale_factor: type: - string - number description: Fraction of a table's rows that must change before autovacuum runs ANALYZE to refresh planner statistics. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_analyze_scale_factor/ example: 0.1 minimum: 0 autovacuum_vacuum_insert_scale_factor: type: - string - number description: Fraction of a table's rows that must be inserted before autovacuum runs. Helps vacuum insert-heavy, rarely-updated tables. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_vacuum_insert_scale_factor/ example: 0.2 minimum: 0 autovacuum_vacuum_cost_limit: type: - string - integer description: Cost-accounting limit shared across all autovacuum workers before they pause. Use -1 to inherit vacuum_cost_limit. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_vacuum_cost_limit/ example: '-1' minimum: 1 autovacuum_vacuum_cost_delay: type: - string - integer description: Time autovacuum sleeps when the cost limit is reached. Lower values speed up vacuuming at the cost of more I/O. externalDocs: url: https://postgresqlco.nf/doc/en/param/autovacuum_vacuum_cost_delay/ example: 2ms minimum: 0 additionalProperties: false minProperties: 1 example: max_connections: 100 pgStorageSize: type: integer title: Storage Size description: The storage size, in GiB, which must be supported by the specified `size`. pgPitrRestoreTargetProperty: type: string format: date-time title: PITR Restore Target as an RFC 3339-formatted timestamp in UTC time. example: '2026-03-31T18:17:37Z' description: The point in time at which to recover, as either date/time, named restore point, or a specific transaction ID. PostgresQueryExecution: properties: timestamp: description: Execution timestamp (RFC 3339). type: string format: date-time queryId: description: Stable identifier for the query pattern. type: string dbName: description: Database the query ran in. type: string dbUser: description: Database user that executed the query. type: string dbOperation: description: Top-level SQL operation type. type: string app: description: Value of the Postgres `application_name` for this execution. type: string queryText: description: Normalized query text for this execution. type: string pid: description: Postgres backend process ID that executed the query. type: string durationUs: description: Execution duration in microseconds. type: integer rows: description: Rows returned or affected. type: integer sharedBlksHit: description: Shared buffer blocks hit. type: integer sharedBlksRead: description: Shared buffer blocks read from disk. type: integer sharedBlksWritten: description: Shared buffer blocks written. type: integer sharedBlksDirtied: description: Shared buffer blocks dirtied. type: integer sharedBlkReadTimeUs: description: Time spent reading shared blocks, in microseconds. type: integer sharedBlkWriteTimeUs: description: Time spent writing shared blocks, in microseconds. type: integer localBlksHit: description: Local buffer blocks hit (temp tables). type: integer localBlksRead: description: Local buffer blocks read (temp tables). type: integer localBlksWritten: description: Local buffer blocks written (temp tables). type: integer localBlksDirtied: description: Local buffer blocks dirtied (temp tables). type: integer tempBlksRead: description: Temp blocks read (spills to disk). type: integer tempBlksWritten: description: Temp blocks written (spills to disk). type: integer tempBlkReadTimeUs: description: Time spent reading temp blocks, in microseconds. type: integer tempBlkWriteTimeUs: description: Time spent writing temp blocks, in microseconds. type: integer walRecords: description: Number of WAL records produced. type: integer walBytes: description: Number of WAL bytes produced. type: integer walFpi: description: Number of WAL full-page images produced. type: integer cpuUserTimeUs: description: CPU time spent in user mode, in microseconds. type: integer cpuSysTimeUs: description: CPU time spent in kernel mode, in microseconds. type: integer jitFunctions: description: Number of JIT-compiled functions. type: integer jitGenerationTimeUs: description: JIT generation time, in microseconds. type: integer jitInliningTimeUs: description: JIT inlining time, in microseconds. type: integer jitOptimizationTimeUs: description: JIT optimization time, in microseconds. type: integer jitEmissionTimeUs: description: JIT emission time, in microseconds. type: integer jitDeformTimeUs: description: JIT deform time, in microseconds. type: integer parallelWorkersPlanned: description: Parallel workers planned for this execution. type: integer parallelWorkersLaunched: description: Parallel workers actually launched for this execution. type: integer errMessage: description: Error message if the execution raised an error. type: string errSqlstate: description: Postgres SQLSTATE code if the execution raised an error. type: string errElevel: description: Postgres error severity level if the execution raised an error. type: integer serverRole: description: Role of the server that executed the query (for example, primary or standby). type: string traceId: description: OpenTelemetry trace ID associated with the execution. type: string spanId: description: OpenTelemetry span ID associated with the execution. type: string required: - timestamp - queryId - dbName - dbUser - dbOperation - app - queryText - pid - durationUs - rows - sharedBlksHit - sharedBlksRead - sharedBlksWritten - sharedBlksDirtied - sharedBlkReadTimeUs - sharedBlkWriteTimeUs - localBlksHit - localBlksRead - localBlksWritten - localBlksDirtied - tempBlksRead - tempBlksWritten - tempBlkReadTimeUs - tempBlkWriteTimeUs - walRecords - walBytes - walFpi - cpuUserTimeUs - cpuSysTimeUs - jitFunctions - jitGenerationTimeUs - jitInliningTimeUs - jitOptimizationTimeUs - jitEmissionTimeUs - jitDeformTimeUs - parallelWorkersPlanned - parallelWorkersLaunched - serverRole pgNameProperty: type: string title: Postgres Service Name description: Name of the Postgres service. Alphanumerical string with whitespaces up to 50 characters. minLength: 1 maxLength: 50 pgHaType: type: string description: 'Type of high availability: “none” for no replication, “async” for asynchronous replication to a single standby, and “sync” for synchronous replication to two standbys.' enum: - none - async - sync PostgresServicePostRequest: properties: name: $ref: '#/components/schemas/pgNameProperty' provider: $ref: '#/components/schemas/pgProvider' region: $ref: '#/components/schemas/pgRegion' postgresVersion: $ref: '#/components/schemas/pgVersion' size: $ref: '#/components/schemas/pgSize' haType: $ref: '#/components/schemas/pgHaType' tags: $ref: '#/components/schemas/pgTags' pgConfig: $ref: '#/components/schemas/pgConfig' pgBouncerConfig: $ref: '#/components/schemas/pgBouncerConfig' required: - name - provider - region - size postgresInstanceUpdateConfigResponse: properties: pgConfig: $ref: '#/components/schemas/pgConfig' pgBouncerConfig: $ref: '#/components/schemas/pgBouncerConfig' message: description: Informational message about the configuration update, such as restart requirements. type: string required: - pgConfig - pgBouncerConfig pgPassword: title: Password type: string description: '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 ' minLength: 12 maxLength: 1024 allOf: - pattern: '[a-z]' - pattern: '[A-Z]' - pattern: '[0-9]' pgStateProperty: type: string title: Postgres Service State description: Current state of the service enum: - creating - restarting - running - replaying_wal - restoring_backup - finalizing_restore - unavailable - stopped - deleting PostgresMetrics: properties: metrics: type: array description: Available metrics, each with its bucketed time series. items: $ref: '#/components/schemas/PostgresMetric' required: - metrics pgBouncerConfig: type: object title: PgBouncer Configuration description: PgBouncer [runtime configuration](https://www.pgbouncer.org/config.html) configuration. additionalProperties: type: string description: Any PgBouncer configuration parameter. minProperties: 1 maxProperties: 64 example: default_pool_size: '16' pgTags: type: array items: $ref: '#/components/schemas/ResourceTagsV1' maxItems: 50 title: Postgres Tags description: Tags associated with the Postgres service. Tag keys starting with “chc_” are reserved for internal use. PostgresMetricDataPoint: properties: timestamp: description: Bucket start time as a Unix timestamp in seconds. type: integer value: description: Metric value for the bucket. type: number required: - timestamp - value pgCreatedAtProperty: type: string format: date-time title: Postgres Service creation timestamp example: '2026-03-26T20:51:16.384Z' PostgresMetricSeries: properties: label: description: Distinguishing label for this series within the metric (for example a CPU mode, a database name, or "Reads"). type: string dataPoints: type: array description: Time-ordered data points, one per bucket. items: $ref: '#/components/schemas/PostgresMetricDataPoint' required: - label - dataPoints PostgresService: properties: name: $ref: '#/components/schemas/pgNameProperty' provider: $ref: '#/components/schemas/pgProvider' region: $ref: '#/components/schemas/pgRegion' postgresVersion: $ref: '#/components/schemas/pgVersion' size: $ref: '#/components/schemas/pgSize' haType: $ref: '#/components/schemas/pgHaType' tags: $ref: '#/components/schemas/pgTags' id: $ref: '#/components/schemas/pgIdProperty' storageSize: $ref: '#/components/schemas/pgStorageSize' state: $ref: '#/components/schemas/pgStateProperty' createdAt: $ref: '#/components/schemas/pgCreatedAtProperty' isPrimary: $ref: '#/components/schemas/pgIsPrimaryProperty' connectionString: description: Connection string to the Postgres service. Embeds the service password, so it is only returned when the service is created or its password is reset. Omitted from every other response when Postgres credential redaction is enabled for the organization. Not guaranteed to be present — treat as optional. type: string username: description: Username for the Postgres service type: string password: description: Password for the Postgres service. Only returned when the service is created or its password is reset. Omitted from every other response when Postgres credential redaction is enabled for the organization. Not guaranteed to be present — treat as optional. type: string hostname: description: Hostname for the Postgres service type: string PostgresLogEntry: properties: timestamp: description: Time the entry was logged (RFC 3339). type: string format: date-time severity: description: PostgreSQL severity of the entry (for example, LOG, WARNING, ERROR, FATAL, PANIC). type: string body: description: Raw log entry body as emitted by PostgreSQL. Structured bodies are returned as a JSON-encoded string. type: string required: - timestamp - severity - body PostgresServicePasswordResource: properties: password: description: New Postgres superuser password. Provided only if there was no 'password' in the request. type: string PostgresServiceSetState: properties: command: description: Postgres status, which initiates a process. type: string enum: - restart - promote - switchover PostgresMetric: properties: key: description: Stable metric identifier (for example cpu_usage, connection_count, cache_hit_ratio). type: string name: description: Human-readable metric name. type: string unit: description: Unit of the metric values (for example %, IOPS, bytes/s, count). type: string description: description: Human-readable description of what the metric measures. type: string series: type: array description: One series per label dimension of the metric. items: $ref: '#/components/schemas/PostgresMetricSeries' required: - key - name - unit - description - series PostgresServicePatchRequest: properties: name: $ref: '#/components/schemas/pgNameProperty' size: $ref: '#/components/schemas/pgSize' haType: $ref: '#/components/schemas/pgHaType' tags: $ref: '#/components/schemas/pgTags' PostgresServiceRestoreRequest: properties: name: $ref: '#/components/schemas/pgNameProperty' restoreTarget: $ref: '#/components/schemas/pgPitrRestoreTargetProperty' pgConfig: $ref: '#/components/schemas/pgConfig' pgBouncerConfig: $ref: '#/components/schemas/pgBouncerConfig' tags: $ref: '#/components/schemas/pgTags' required: - name - restoreTarget PostgresSlowQueryPattern: properties: queryId: description: Stable identifier for the query pattern (normalized SQL). type: string queryText: description: Normalized query text with literals replaced by placeholders. type: string dbName: description: Database the query ran in. type: string dbUser: description: Database user that executed the query. type: string dbOperation: description: Top-level SQL operation type (for example, SELECT, INSERT, UPDATE, DELETE, UTILITY). type: string app: description: Value of the Postgres `application_name` for executions matching this pattern. type: string callCount: description: Number of times the pattern executed in the window. type: integer errorCount: description: Number of executions of the pattern that raised an error. type: integer totalDurationUs: description: Total execution time across all calls, in microseconds. type: integer avgDurationUs: description: Average execution time per call, in microseconds. type: integer maxDurationUs: description: Maximum execution time of any call, in microseconds. type: integer p50DurationUs: description: 50th percentile execution time, in microseconds. type: integer p95DurationUs: description: 95th percentile execution time, in microseconds. type: integer p99DurationUs: description: 99th percentile execution time, in microseconds. type: integer totalRows: description: Total number of rows returned or affected across all calls. type: integer totalSharedBlksRead: description: Total shared buffer blocks read from disk (cache misses) across all calls. type: integer totalSharedBlksHit: description: Total shared buffer blocks hit (cache hits) across all calls. type: integer totalCpuTimeUs: description: Total CPU time across all calls, in microseconds. type: integer totalWalBytes: description: Total WAL (write-ahead log) bytes generated across all calls. type: integer required: - queryId - queryText - dbName - dbUser - dbOperation - app - callCount - errorCount - totalDurationUs - avgDurationUs - maxDurationUs - p50DurationUs - p95DurationUs - p99DurationUs - totalRows - totalSharedBlksRead - totalSharedBlksHit - totalCpuTimeUs - totalWalBytes pgSize: type: string title: VM size description: The VM size for a Postgres service. enum: - c6gd.large - c6gd.xlarge - c6gd.2xlarge - c6gd.4xlarge - c6gd.8xlarge - c6gd.16xlarge - i7i.large - i7i.xlarge - i7i.2xlarge - i7i.4xlarge - i7i.8xlarge - i7i.12xlarge - i7i.16xlarge - i7i.24xlarge - i7ie.large - i7ie.xlarge - i7ie.2xlarge - i7ie.3xlarge - i7ie.6xlarge - i7ie.12xlarge - i7ie.18xlarge - i7ie.24xlarge - i8g.large - i8g.xlarge - i8g.2xlarge - i8g.4xlarge - i8g.8xlarge - i8g.16xlarge - i8g.24xlarge - i8ge.large - i8ge.xlarge - i8ge.2xlarge - i8ge.3xlarge - i8ge.6xlarge - i8ge.12xlarge - i8ge.18xlarge - i8ge.24xlarge - m6gd.large - m6gd.xlarge - m6gd.2xlarge - m6gd.4xlarge - m6gd.8xlarge - m6gd.16xlarge - m6id.large - m6id.xlarge - m6id.2xlarge - m6id.4xlarge - m6id.8xlarge - m6id.16xlarge - m8gd.large - m8gd.xlarge - m8gd.2xlarge - m8gd.4xlarge - m8gd.8xlarge - m8gd.16xlarge - r6gd.medium - r6gd.large - r6gd.xlarge - r6gd.2xlarge - r6gd.4xlarge - r6gd.8xlarge - r6gd.12xlarge - r6gd.16xlarge - r6id.large - r6id.xlarge - r6id.2xlarge - r6id.4xlarge - r6id.8xlarge - r6id.12xlarge - r6id.16xlarge - r6id.24xlarge - r6id.32xlarge - r8gd.medium - r8gd.large - r8gd.xlarge - r8gd.2xlarge - r8gd.4xlarge - r8gd.8xlarge - r8gd.12xlarge - r8gd.16xlarge - r8gd.24xlarge - r8gd.48xlarge - c4a-highmem-4 - c4a-highmem-8 - c4a-highmem-16 - c4a-highmem-32 - c4a-highmem-48 - c4a-highmem-64 - c4a-highmem-72 - c4a-standard-4 - c4a-standard-8 - c4a-standard-16 - c4a-standard-32 - c4a-standard-48 - c4a-standard-64 - c4a-standard-72 - c4-highmem-4 - c4-highmem-8 - c4-highmem-16 - c4-highmem-24 - c4-highmem-32 - c4-highmem-48 - c4-highmem-96 - c4-highmem-144 - c4-highmem-192 - c4-highmem-288 - c4-standard-4 - c4-standard-8 - c4-standard-16 - c4-standard-24 - c4-standard-32 - c4-standard-48 - c4-standard-96 - c4-standard-144 - c4-standard-192 - c4-standard-288 - c4d-highmem-8 - c4d-highmem-16 - c4d-highmem-32 - c4d-highmem-48 - c4d-highmem-64 - c4d-highmem-96 - c4d-highmem-192 - c4d-highmem-384 - c4d-standard-8 - c4d-standard-16 - c4d-standard-32 - c4d-standard-48 - c4d-standard-64 - c4d-standard-96 - c4d-standard-192 - c4d-standard-384 - z3-highlssd-8 - z3-highlssd-16 - z3-highlssd-22 - z3-highlssd-32 - z3-highlssd-44 - z3-highlssd-88 - z3-standardlssd-14 - z3-standardlssd-22 - z3-standardlssd-44 - z3-standardlssd-88 - z3-standardlssd-176 PostgresServiceReadReplicaRequest: properties: name: $ref: '#/components/schemas/pgNameProperty' pgConfig: $ref: '#/components/schemas/pgConfig' pgBouncerConfig: $ref: '#/components/schemas/pgBouncerConfig' tags: $ref: '#/components/schemas/pgTags' required: - name postgresInstanceConfig: properties: pgConfig: $ref: '#/components/schemas/pgConfig' pgBouncerConfig: $ref: '#/components/schemas/pgBouncerConfig' required: - pgConfig - pgBouncerConfig pgVersion: type: string title: Postgres major version enum: - '18' - '17' pgIsPrimaryProperty: type: boolean title: Postgres Service is Primary description: True if this service is the primary service in the data warehouse default: false PostgresServiceSetPassword: properties: password: $ref: '#/components/schemas/pgPassword' securitySchemes: basicAuth: type: http scheme: basic description: 'Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi' x-tagGroups: - name: Organization tags: - Organization - Billing - User management - Role Management - UDF - name: Service tags: - Service - Backup - name: API keys tags: - API keys - name: Prometheus tags: - Prometheus - name: ClickPipes tags: - ClickPipes - name: ClickStack tags: - ClickStack - name: Postgres tags: - Postgres