Skip to main content
PATCH
Update the PostgreSQL private endpoint
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Approves VPC endpoints by ID and sets the supported regions. At least one of allowedVpcEndpoints and supportedRegions is required, and each one provided replaces the existing list in full, so include every entry to keep. Private endpoints are available only for AWS Postgres services, and only for organizations with the feature enabled.

Permission

The API key must have the control-plane:postgres-service:manage permission.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the Postgres service.

postgresId
string<uuid>
required

ID of the Postgres service.

Body

application/json
allowedVpcEndpoints
object[]

Full replacement of the approved VPC endpoints: endpoints not listed are no longer allowed to connect. Each endpoint ID must be unique.

Maximum array length: 50
Example:
supportedRegions
string[]

Full replacement of the supported regions. AWS region IDs, other than the service region, from which VPC endpoints can connect, such as us-west-2. The service region is always supported and must not be listed. Requires cross-region private endpoints to be enabled for the organization.

Example:

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object