POST
/
api
/
v1
/
services
/
{id}
/
create_replica
Create a read replica of a PostgreSQL service
curl --request POST \
  --url https://app.miget.com/api/v1/services/{id}/create_replica \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpu_size": 123,
  "ram_size": 123
}
'
{
  "uuid": "<string>",
  "name": "<string>",
  "label": "<string>",
  "service_type": "<string>",
  "project_id": "<string>",
  "resource_id": "<string>",
  "miget_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connection_details": {
    "internal": {
      "hostname": "my-service-xxx.internal",
      "database": "db_name",
      "port": 5432,
      "username": "db_user",
      "password": "db_password",
      "connection_url": "postgres://db_user:db_password@my-service-xxx.internal:5432/db_name"
    },
    "external": {
      "external_connection_url": "postgres://db_user:db_password@my-service-xxx.external:5432/db_name",
      "psql_command": "PGPASSWORD=db_password psql -h my-service-xxx.external -U db_user db_name"
    }
  }
}

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

​
id
string
required

Service ID

Body

application/json

Create a read replica of a PostgreSQL service

​
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 service

Api_V1_Entities_Service model

​
uuid
string
required

Service UUID

​
name
string
required

Service name

​
label
string
required

Display name

​
service_type
string
required

Service type (postgres, shared_storage)

​
project_id
string
required

Associated project UUID

​
resource_id
string
required

Assigned resource UUID

​
miget_id
string
required

DEPRECATED: use resource_id instead

​
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 service

Example:
{
  "internal": {
    "hostname": "my-service-xxx.internal",
    "database": "db_name",
    "port": 5432,
    "username": "db_user",
    "password": "db_password",
    "connection_url": "postgres://db_user:db_password@my-service-xxx.internal:5432/db_name"
  },
  "external": {
    "external_connection_url": "postgres://db_user:db_password@my-service-xxx.external:5432/db_name",
    "psql_command": "PGPASSWORD=db_password psql -h my-service-xxx.external -U db_user db_name"
  }
}