POST
Create a read replica of a PostgreSQL add-on

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid
string
required

Application UUID

id
string
required

Add-on ID or UUID

Body

application/json

Create a read replica of a PostgreSQL add-on

cpu_size
number<float>

CPU allocation for the replica (defaults to primary's value)

ram_size
integer<int32>

RAM allocation in megabytes (defaults to primary's value)

Response

Create a read replica of a PostgreSQL add-on

Api_V1_Entities_Addon model

uuid
string
required

Add-on UUID

name
string
required

Add-on name

type
string
required

Add-on type (postgres, mysql, valkey, storage, cronjob)

label
string
required

Display name

state
string
required

Current state. While provisioning: pending, processing, creating, stopped. Once running, the live Kubernetes status: healthy (postgres/mysql/valkey), bound (storage), or running when the status is unavailable. Unhealthy: degraded, degradated, failing, lost, crashloopbackoff, failed

quota
object
required

Raw resource quota row, with ram_size and disk_size in bytes. Use ram_size, disk_size and cpu_size for the values accepted by POST and PUT /apps/{uuid}/addons

ram_size
number<float>
required

RAM allocation in MiB, the unit POST and PUT /apps/{uuid}/addons accept, rounded to 6 decimal places. Null when the add-on has no quota

disk_size
number<float>
required

Disk allocation in GiB, the unit POST and PUT /apps/{uuid}/addons accept, rounded to 6 decimal places. Null when the add-on has no quota

cpu_size
number<float>
required

CPU allocation in cores, the unit POST and PUT /apps/{uuid}/addons accept. On a free plan, creating a postgres, mysql or valkey add-on stores 0.1 whatever cpu_size was sent; PUT stores the value sent. Null when the add-on has no quota

service_id
integer<int32>
required

Numeric ID of the service a storage add-on is mounted from, the value POST /apps/{uuid}/addons accepts as service_id. Null for add-ons not mounted from a service

backup_enabled
boolean
required

Postgres only, null for other types. The effective value the platform applies: false on a free plan whatever was stored, otherwise the stored value, true when never set

scheduled_backup
string
required

Postgres only, null for other types. The effective backup schedule as a 6-field cron expression: the stored schedule, or 0 0 3 * * * when none was set

role
string
required

Postgres only: primary or replica. Null for other types

primary_addon_uuid
string
required

UUID of the primary add-on, for a replica. Null otherwise

replicas
object[]
required

Replicas of a primary Postgres add-on, each with uuid, name, label and state. Null for other add-ons

settings
object
required

Add-on specific settings

var
object
required

Connection environment variables

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

connection_details
object
required

Connection details for the addon

Example: