POST
/
api
/
v1
/
apps
/
{uuid}
/
addons
Create a new add-on
curl --request POST \
  --url https://app.miget.com/api/v1/apps/{uuid}/addons \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "postgres",
  "label": "<string>",
  "ram_size": 123,
  "disk_size": 123,
  "cpu_size": 123,
  "postgres_version": "<string>",
  "mysql_version": "<string>",
  "valkey_version": "<string>",
  "public_access": "0",
  "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>",
  "service_id": 123,
  "mount_point": "<string>",
  "storage_access": "RWO"
}
'
{
  "uuid": "<string>",
  "name": "<string>",
  "type": "<string>",
  "label": "<string>",
  "state": "<string>",
  "quota": {},
  "settings": {},
  "var": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connection_details": {
    "internal": {
      "hostname": "my-addon-xxx.internal",
      "database": "db_name",
      "port": 5432,
      "username": "db_user",
      "password": "db_password",
      "connection_url": "postgres://db_user:db_password@my-addon-xxx.internal:5432/db_name"
    },
    "external": {
      "external_connection_url": "postgres://db_user:db_password@my-addon-xxx.external:5432/db_name",
      "psql_command": "PGPASSWORD=db_password psql -h my-addon-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

​
uuid
string
required

Application UUID

Body

application/json

Create a new add-on

​
type
enum<string>
required

Add-on type: 'postgres' (PostgreSQL), 'mysql' (MySQL), 'valkey' (Redis-compatible cache), 'storage' (persistent volume)

Available options:
postgres,
mysql,
valkey,
storage
​
label
string

Human-readable display name for the add-on

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

​
mysql_version
string

MySQL version (e.g., '8.0', '8.4'). Only for mysql type.

​
valkey_version
string

Valkey version (e.g., '7.2'). Only for valkey type.

​
public_access
enum<string>

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

Available options:
0,
1
​
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'.

​
service_id
integer<int32>

Associated service ID for shared storage add-ons

​
mount_point
string

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

​
storage_access
enum<string>

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

Available options:
RWO,
RWX

Response

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

​
quota
object
required

Resource quota configuration

​
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:
{
  "internal": {
    "hostname": "my-addon-xxx.internal",
    "database": "db_name",
    "port": 5432,
    "username": "db_user",
    "password": "db_password",
    "connection_url": "postgres://db_user:db_password@my-addon-xxx.internal:5432/db_name"
  },
  "external": {
    "external_connection_url": "postgres://db_user:db_password@my-addon-xxx.external:5432/db_name",
    "psql_command": "PGPASSWORD=db_password psql -h my-addon-xxx.external -U db_user db_name"
  }
}