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,
"public_access": true,
"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_enabled": true,
"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,
"public_access": True,
"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_enabled": True,
"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,
public_access: true,
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_enabled: true,
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,
'public_access' => true,
'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_enabled' => true,
'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 \"public_access\": true,\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_enabled\": true,\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 \"public_access\": true,\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_enabled\": true,\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 \"public_access\": true,\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_enabled\": true,\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"
}
}
}Services
Create a new service
Creates a standalone service (database or shared storage) that can be shared across multiple applications in a project.
POST
/
api
/
v1
/
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,
"public_access": true,
"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_enabled": true,
"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,
"public_access": True,
"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_enabled": True,
"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,
public_access: true,
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_enabled: true,
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,
'public_access' => true,
'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_enabled' => true,
'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 \"public_access\": true,\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_enabled\": true,\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 \"public_access\": true,\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_enabled\": true,\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 \"public_access\": true,\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_enabled\": true,\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
Bearer token for authentication. Format: 'Bearer {token}'
Headers
Workspace ID (uses default workspace if not provided)
Body
application/json
Create a new service
Service type: 'postgres' (PostgreSQL database), 'shared_storage' (shared persistent volume)
Available options:
postgres, shared_storage UUID of the project to create the service in
Human-readable display name for the service
UUID of the compute resource to provision the service on
DEPRECATED: use resource_id instead
RAM allocation in MiB (e.g., 64, 128, 256)
Disk storage in GiB (e.g., 1, 5, 10)
CPU allocation in cores (e.g., 0.1, 0.25, 0.5)
Enable public internet access. Accepts true/false or '1'/'0'. For postgres type.
Automatically inject connection environment variables into parent application
Number of database instances (1 for standalone, 3/5/7 for HA cluster). For postgres type.
Available options:
1, 3, 5, 7 Creation mode: 'fresh' (new database, default), 'external_replica' (replica of external PostgreSQL). For postgres type.
Available options:
fresh, external_replica Hostname of the external PostgreSQL source database. Required for external_replica mode.
Port of the external PostgreSQL source database. Required for external_replica mode.
Authentication method for external replica: 'password' or 'tls'. Required for external_replica mode.
Available options:
password, tls Username for replication connection to external database.
Password for replication connection (password auth). Required when auth_type is 'password'.
CA certificate for TLS authentication. Required when auth_type is 'tls'.
TLS client certificate. Required when auth_type is 'tls'.
TLS client key. Required when auth_type is 'tls'.
Enable S3 WAL archive fallback. Accepts true/false or '1'/'0'. For external_replica mode.
S3 endpoint URL. Required when s3_enabled is true.
S3 bucket name. Required when s3_enabled is true.
S3 path prefix. Required when s3_enabled is true.
S3 access key. Required when s3_enabled is true.
S3 secret key. Required when s3_enabled is true.
Archive server name from barman-cloud-wal-archive. Required when s3_enabled is true.
Access mode: 'RWO' (single node read-write), 'RWX' (multi-node read-write). For shared_storage type.
Available options:
RWO, RWX PostgreSQL major version. Required for postgres type.
Available options:
18, 17, 16, 15, 14, 13 Container mount path (e.g., /data). Required for shared_storage type.
Response
Create a new service
Api_V1_Entities_Service model
Service UUID
Service name
Display name
Service type (postgres, shared_storage)
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
Associated project UUID
Assigned resource UUID
DEPRECATED: use resource_id instead
Creation timestamp
Last update timestamp
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"
}
}