Create a new service

curl --request POST \ --url https://app.miget.com/api/v1/services \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "service_type": "postgres", "project_id": "<string>", "miget_id": "<string>", "label": "<string>", "ram_size": 123, "disk_size": 123, "cpu_size": 123, "postgres_version": "<string>", "public_access": "0", "environment_variables": true, "instances": 1, "creation_mode": "fresh", "external_host": "<string>", "external_port": 123, "auth_type": "password", "replication_username": "<string>", "replication_password": "<string>", "ca_crt": "<string>", "tls_crt": "<string>", "tls_key": "<string>", "s3_enabled": "0", "s3_endpoint": "<string>", "s3_bucket": "<string>", "s3_path": "<string>", "s3_access_key": "<string>", "s3_secret_key": "<string>", "s3_server_name": "<string>", "mount_point": "<string>", "storage_access": "RWO" } '

{ "uuid": "<string>", "name": "<string>", "label": "<string>", "service_type": "<string>", "project_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)

Body

application/json

Create a new service

service_type

enum<string>

required

Service type: 'postgres' (PostgreSQL database), 'shared_storage' (shared persistent volume)

Available options:

postgres,

shared_storage

project_id

string

required

UUID of the project to create the service in

miget_id

string

required

UUID of the compute resource to provision the service on

label

string

required

Human-readable display name for the service

ram_size

number<float>

RAM allocation in MiB (e.g., 64, 128, 256)

disk_size

number<float>

Disk storage in GiB (e.g., 1, 5, 10)

cpu_size

number<float>

CPU allocation in cores (e.g., 0.1, 0.25, 0.5)

postgres_version

string

PostgreSQL version (e.g., '15', '16'). Only for postgres type.

public_access

enum<string>

Enable public internet access: '0' disabled, '1' enabled. For postgres type.

Available options:

0,

1

environment_variables

boolean

Automatically inject connection environment variables into parent application

instances

enum<integer>

Number of database instances (1 for standalone, 3/5/7 for HA cluster). For postgres type.

Available options:

1,

3,

5,

7

creation_mode

enum<string>

Creation mode: 'fresh' (new database, default), 'external_replica' (replica of external PostgreSQL). For postgres type.

Available options:

fresh,

external_replica

external_host

string

Hostname of the external PostgreSQL source database. Required for external_replica mode.

external_port

integer<int32>

Port of the external PostgreSQL source database. Required for external_replica mode.

auth_type

enum<string>

Authentication method for external replica: 'password' or 'tls'. Required for external_replica mode.

Available options:

password,

tls

replication_username

string

Username for replication connection to external database.

replication_password

string

Password for replication connection (password auth). Required when auth_type is 'password'.

ca_crt

string

CA certificate for TLS authentication. Required when auth_type is 'tls'.

tls_crt

string

TLS client certificate. Required when auth_type is 'tls'.

tls_key

string

TLS client key. Required when auth_type is 'tls'.

s3_enabled

enum<string>

Enable S3 WAL archive fallback: '0' disabled, '1' enabled. For external_replica mode.

Available options:

0,

1

s3_endpoint

string

S3 endpoint URL. Required when s3_enabled is '1'.

s3_bucket

string

S3 bucket name. Required when s3_enabled is '1'.

s3_path

string

S3 path prefix. Required when s3_enabled is '1'.

s3_access_key

string

S3 access key. Required when s3_enabled is '1'.

s3_secret_key

string

S3 secret key. Required when s3_enabled is '1'.

s3_server_name

string

Archive server name from barman-cloud-wal-archive. Required when s3_enabled is '1'.

mount_point

string

Container mount path (e.g., /data). For shared_storage type.

storage_access

enum<string>

Access mode: 'RWO' (single node read-write), 'RWX' (multi-node read-write). For shared_storage type.

Available options:

RWO,

RWX

Response

Create a new 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

miget_id

string

required

Assigned resource UUID

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"
  }
}

Overview

Miget API

Create a new service

Authorizations

Headers

Body

Response