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",
  "name": "<string>",
  "label": "<string>",
  "ram_size": 123,
  "disk_size": 123,
  "cpu_size": 123,
  "postgres_version": "<string>",
  "mysql_version": "<string>",
  "valkey_version": "<string>",
  "public_access": "0",
  "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"
}

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
name
string
required

Unique add-on identifier (used in environment variable names)

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