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 '
{
  "project_id": "<string>",
  "label": "<string>",
  "resource_id": "<string>",
  "miget_id": "<string>",
  "ram_size": 123,
  "disk_size": 123,
  "cpu_size": 123,
  "environment_variables": true,
  "external_host": "<string>",
  "external_port": 123,
  "replication_username": "<string>",
  "replication_password": "<string>",
  "ca_crt": "<string>",
  "tls_crt": "<string>",
  "tls_key": "<string>",
  "s3_endpoint": "<string>",
  "s3_bucket": "<string>",
  "s3_path": "<string>",
  "s3_access_key": "<string>",
  "s3_secret_key": "<string>",
  "s3_server_name": "<string>",
  "mount_point": "<string>"
}
'

import requests

url = "https://app.miget.com/api/v1/services"

payload = {
    "project_id": "<string>",
    "label": "<string>",
    "resource_id": "<string>",
    "miget_id": "<string>",
    "ram_size": 123,
    "disk_size": 123,
    "cpu_size": 123,
    "environment_variables": True,
    "external_host": "<string>",
    "external_port": 123,
    "replication_username": "<string>",
    "replication_password": "<string>",
    "ca_crt": "<string>",
    "tls_crt": "<string>",
    "tls_key": "<string>",
    "s3_endpoint": "<string>",
    "s3_bucket": "<string>",
    "s3_path": "<string>",
    "s3_access_key": "<string>",
    "s3_secret_key": "<string>",
    "s3_server_name": "<string>",
    "mount_point": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    label: '<string>',
    resource_id: '<string>',
    miget_id: '<string>',
    ram_size: 123,
    disk_size: 123,
    cpu_size: 123,
    environment_variables: true,
    external_host: '<string>',
    external_port: 123,
    replication_username: '<string>',
    replication_password: '<string>',
    ca_crt: '<string>',
    tls_crt: '<string>',
    tls_key: '<string>',
    s3_endpoint: '<string>',
    s3_bucket: '<string>',
    s3_path: '<string>',
    s3_access_key: '<string>',
    s3_secret_key: '<string>',
    s3_server_name: '<string>',
    mount_point: '<string>'
  })
};

fetch('https://app.miget.com/api/v1/services', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.miget.com/api/v1/services",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'label' => '<string>',
    'resource_id' => '<string>',
    'miget_id' => '<string>',
    'ram_size' => 123,
    'disk_size' => 123,
    'cpu_size' => 123,
    'environment_variables' => true,
    'external_host' => '<string>',
    'external_port' => 123,
    'replication_username' => '<string>',
    'replication_password' => '<string>',
    'ca_crt' => '<string>',
    'tls_crt' => '<string>',
    'tls_key' => '<string>',
    's3_endpoint' => '<string>',
    's3_bucket' => '<string>',
    's3_path' => '<string>',
    's3_access_key' => '<string>',
    's3_secret_key' => '<string>',
    's3_server_name' => '<string>',
    'mount_point' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.miget.com/api/v1/services"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.miget.com/api/v1/services")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

POST

api

services

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 '
{
  "project_id": "<string>",
  "label": "<string>",
  "resource_id": "<string>",
  "miget_id": "<string>",
  "ram_size": 123,
  "disk_size": 123,
  "cpu_size": 123,
  "environment_variables": true,
  "external_host": "<string>",
  "external_port": 123,
  "replication_username": "<string>",
  "replication_password": "<string>",
  "ca_crt": "<string>",
  "tls_crt": "<string>",
  "tls_key": "<string>",
  "s3_endpoint": "<string>",
  "s3_bucket": "<string>",
  "s3_path": "<string>",
  "s3_access_key": "<string>",
  "s3_secret_key": "<string>",
  "s3_server_name": "<string>",
  "mount_point": "<string>"
}
'

import requests

url = "https://app.miget.com/api/v1/services"

payload = {
    "project_id": "<string>",
    "label": "<string>",
    "resource_id": "<string>",
    "miget_id": "<string>",
    "ram_size": 123,
    "disk_size": 123,
    "cpu_size": 123,
    "environment_variables": True,
    "external_host": "<string>",
    "external_port": 123,
    "replication_username": "<string>",
    "replication_password": "<string>",
    "ca_crt": "<string>",
    "tls_crt": "<string>",
    "tls_key": "<string>",
    "s3_endpoint": "<string>",
    "s3_bucket": "<string>",
    "s3_path": "<string>",
    "s3_access_key": "<string>",
    "s3_secret_key": "<string>",
    "s3_server_name": "<string>",
    "mount_point": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    label: '<string>',
    resource_id: '<string>',
    miget_id: '<string>',
    ram_size: 123,
    disk_size: 123,
    cpu_size: 123,
    environment_variables: true,
    external_host: '<string>',
    external_port: 123,
    replication_username: '<string>',
    replication_password: '<string>',
    ca_crt: '<string>',
    tls_crt: '<string>',
    tls_key: '<string>',
    s3_endpoint: '<string>',
    s3_bucket: '<string>',
    s3_path: '<string>',
    s3_access_key: '<string>',
    s3_secret_key: '<string>',
    s3_server_name: '<string>',
    mount_point: '<string>'
  })
};

fetch('https://app.miget.com/api/v1/services', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.miget.com/api/v1/services",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'project_id' => '<string>',
    'label' => '<string>',
    'resource_id' => '<string>',
    'miget_id' => '<string>',
    'ram_size' => 123,
    'disk_size' => 123,
    'cpu_size' => 123,
    'environment_variables' => true,
    'external_host' => '<string>',
    'external_port' => 123,
    'replication_username' => '<string>',
    'replication_password' => '<string>',
    'ca_crt' => '<string>',
    'tls_crt' => '<string>',
    'tls_key' => '<string>',
    's3_endpoint' => '<string>',
    's3_bucket' => '<string>',
    's3_path' => '<string>',
    's3_access_key' => '<string>',
    's3_secret_key' => '<string>',
    's3_server_name' => '<string>',
    'mount_point' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.miget.com/api/v1/services"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.miget.com/api/v1/services")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/services")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"label\": \"<string>\",\n  \"resource_id\": \"<string>\",\n  \"miget_id\": \"<string>\",\n  \"ram_size\": 123,\n  \"disk_size\": 123,\n  \"cpu_size\": 123,\n  \"environment_variables\": true,\n  \"external_host\": \"<string>\",\n  \"external_port\": 123,\n  \"replication_username\": \"<string>\",\n  \"replication_password\": \"<string>\",\n  \"ca_crt\": \"<string>\",\n  \"tls_crt\": \"<string>\",\n  \"tls_key\": \"<string>\",\n  \"s3_endpoint\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_path\": \"<string>\",\n  \"s3_access_key\": \"<string>\",\n  \"s3_secret_key\": \"<string>\",\n  \"s3_server_name\": \"<string>\",\n  \"mount_point\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

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

label

string

required

Human-readable display name for the service

resource_id

string

UUID of the compute resource to provision the service on

miget_id

string

DEPRECATED: use resource_id instead

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)

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

storage_access

enum<string>

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

Available options:

RWO,

RWX

postgres_version

enum<string>

PostgreSQL major version. Required for postgres type.

Available options:

18,

17,

16,

15,

14,

13

mount_point

string

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

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)

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

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

Overview

Miget API

Create a new service

Authorizations

Headers

Body

Response