Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Create the PostgreSQL private endpoint

POST/v1/organizations/{organizationId}/postgres/{postgresId}/privateEndpoint
API playground

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Creates the AWS private endpoint service of a Postgres service. Creation takes about 5 to 10 minutes: state is creating until the service is available. A VPC endpoint can connect only after its ID is approved with the update endpoint. Returns 409 if the service already has a private endpoint. 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

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the Postgres service.

    format: uuid
  • postgresIdstringrequired

    ID of the Postgres service.

    format: uuid

Request bodyJSON

  • supportedRegionsoptionalarray ofstring

    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: ["us-west-2"]

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    10 properties
    • statestringrequired

      State of the private endpoint service: one of 'creating', 'available', 'deleting'. More states may be added. It is creating for about 5 to 10 minutes after creation, then available.

      Example: "available"
    • ipAddressTypestringrequired

      IP address type of the endpoint service.

      Example: "dual"
    • portsarray ofobjectrequired

      Ports the endpoint service forwards.

      2 properties
      • portintegerrequired

        Port exposed by the endpoint service.

        Example: 5432
      • targetPortintegerrequired

        Port on the Postgres service it forwards to.

        Example: 5432
    • supportedRegionsarray ofstringrequired

      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: ["us-west-2"]
    • allowedVpcEndpointsarray ofobjectrequired

      VPC endpoints approved to connect.

      2 properties
      • vpcEndpointIdstringrequired

        ID of the AWS VPC endpoint that is allowed to connect.

        pattern: ^vpce-[0-9a-f]{17}$
        Example: "vpce-0123456789abcdef0"
      • descriptionoptionalstring

        Optional description of the VPC endpoint.

        maxLength: 255
        Example: "Production VPC"
    • endpointServiceNameoptionalstring

      Name of the AWS endpoint service. Use it as the service name when creating a VPC endpoint. Omitted until the service is created.

      Example: "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0"
    • endpointServiceIdoptionalstring

      ID of the AWS endpoint service. Omitted until the service is created.

      Example: "vpce-svc-0123456789abcdef0"
    • privateHostnameoptionalstring

      Hostname that resolves to the Postgres service from an approved VPC endpoint. Omitted until the service is available.

    • privateDnsNameoptionalstring

      Private DNS name of the endpoint service. Omitted until it is assigned.

    • privateDnsVerificationStateoptionalstring

      Verification state of the private DNS name. Omitted until it is assigned.