Skip to main content
POST
Create a private link service in a private subnet of the location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id
string
required

ID of the project

Pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$
Example:

"pjkkmx0f2vke4h36nk9cm8v8q0"

location
string
required

The Ubicloud location/region

Example:

"eu-central-h1"

Private link service ID or name Resource ID or name

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Body

application/json

Neutral settings at the top level; everything provider-shaped under the provider's key, matching the response. The section must be the one of the subnet's location.

private_subnet_id
string
required

ID of the private subnet, in the location, the service lives in

aws
object
required

AWS PrivateLink settings of a service in an AWS location: who may create endpoints to it and from which additional regions.

postgres_resource_id
string

ID of a PostgreSQL database in that subnet to expose

ports
integer[]

Ports consumers connect on; default 5432 and 6432

target_ports
integer[]

Ports the target listens on, one per entry of ports

ip_address_type
enum<string>

Address families consumers connect over; default ipv4. An ipv6 service reaches its targets over IPv6, the others over IPv4

Available options:
ipv4,
ipv6,
dual

Response

Details of a private link service

id
string
required
Pattern: ^pn[0-9a-hj-km-np-tv-z]{24}$
name
string
required
location
string
required
private_subnet
string
required

Name of the private subnet the service lives in

state
enum<string>
required
Available options:
creating,
available,
deleting
postgres_resource
string | null
required

ID of the attached PostgreSQL database, whose primary is the target

ports
object[]
required
allowed_principals
string[]
required

IAM ARNs allowed to connect, or "*" for anyone

ip_address_type
enum<string>
required
Available options:
ipv4,
ipv6,
dual
private_dns_name
string | null
required

Derived from the attached database's private hostname; never user-set

private_hostname
string | null
required

The attached database's private hostname, the name its server certificate carries; consumers reach it through their endpoint once the private DNS name is verified. Null without an attached database

aws
object | null

AWS PrivateLink state of the service