Create a new application
curl --request POST \
--url https://app.miget.com/api/v1/apps \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"name": "<string>",
"project_id": "<string>",
"resource_id": "<string>",
"ram_size": 123,
"cpu_size": 123,
"private_access": true,
"deployment_config": {
"credential_id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"repository": "<string>",
"repository_url": "<string>",
"branch": "<string>",
"dockerfile_path": "<string>",
"build_context": "<string>",
"project_path": "<string>",
"run_command": "<string>",
"language": "<string>",
"build_command": "<string>",
"pre_deploy_command": "<string>",
"post_deploy_command": "<string>",
"use_dhi": true,
"auto_deploy_enabled": true,
"auto_deploy_branch": "<string>",
"parent_app_id": "<string>",
"parent_image_auto_sync": true,
"ssh_keys": [
"<string>"
],
"command": [
"<string>"
],
"args": [
"<string>"
]
},
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://app.miget.com/api/v1/apps"
payload = {
"label": "<string>",
"name": "<string>",
"project_id": "<string>",
"resource_id": "<string>",
"ram_size": 123,
"cpu_size": 123,
"private_access": True,
"deployment_config": {
"credential_id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"repository": "<string>",
"repository_url": "<string>",
"branch": "<string>",
"dockerfile_path": "<string>",
"build_context": "<string>",
"project_path": "<string>",
"run_command": "<string>",
"language": "<string>",
"build_command": "<string>",
"pre_deploy_command": "<string>",
"post_deploy_command": "<string>",
"use_dhi": True,
"auto_deploy_enabled": True,
"auto_deploy_branch": "<string>",
"parent_app_id": "<string>",
"parent_image_auto_sync": True,
"ssh_keys": ["<string>"],
"command": ["<string>"],
"args": ["<string>"]
},
"app_vars_attributes": [
{
"key": "<string>",
"value": "<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({
label: '<string>',
name: '<string>',
project_id: '<string>',
resource_id: '<string>',
ram_size: 123,
cpu_size: 123,
private_access: true,
deployment_config: {
credential_id: '<string>',
image_url: '<string>',
tag: '<string>',
repository: '<string>',
repository_url: '<string>',
branch: '<string>',
dockerfile_path: '<string>',
build_context: '<string>',
project_path: '<string>',
run_command: '<string>',
language: '<string>',
build_command: '<string>',
pre_deploy_command: '<string>',
post_deploy_command: '<string>',
use_dhi: true,
auto_deploy_enabled: true,
auto_deploy_branch: '<string>',
parent_app_id: '<string>',
parent_image_auto_sync: true,
ssh_keys: ['<string>'],
command: ['<string>'],
args: ['<string>']
},
app_vars_attributes: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://app.miget.com/api/v1/apps', 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/apps",
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([
'label' => '<string>',
'name' => '<string>',
'project_id' => '<string>',
'resource_id' => '<string>',
'ram_size' => 123,
'cpu_size' => 123,
'private_access' => true,
'deployment_config' => [
'credential_id' => '<string>',
'image_url' => '<string>',
'tag' => '<string>',
'repository' => '<string>',
'repository_url' => '<string>',
'branch' => '<string>',
'dockerfile_path' => '<string>',
'build_context' => '<string>',
'project_path' => '<string>',
'run_command' => '<string>',
'language' => '<string>',
'build_command' => '<string>',
'pre_deploy_command' => '<string>',
'post_deploy_command' => '<string>',
'use_dhi' => true,
'auto_deploy_enabled' => true,
'auto_deploy_branch' => '<string>',
'parent_app_id' => '<string>',
'parent_image_auto_sync' => true,
'ssh_keys' => [
'<string>'
],
'command' => [
'<string>'
],
'args' => [
'<string>'
]
],
'app_vars_attributes' => [
[
'key' => '<string>',
'value' => '<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/apps"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\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/apps")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.miget.com/api/v1/apps")
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 \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"label": "<string>",
"state": "<string>",
"project_id": "<string>",
"deployment_method": "<string>",
"deployment_config": {},
"builder": "<string>",
"manage_dns_records": true,
"maintenance": true,
"private_access": true,
"service_name": "<string>",
"internal_url": "<string>",
"public_url": "<string>",
"allow_connections": true,
"basic_auth_enabled": true,
"quota": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"miget": {
"uuid": "<string>",
"name": "<string>",
"state": "<string>",
"labels": [
"<string>"
],
"total_disk_size": 123,
"total_ram_size": 123,
"total_cpu_size": 123,
"total_used_disk_size": 123,
"total_used_ram_size": 123,
"total_used_cpu_size": 123,
"available_cpu_size": 123,
"available_disk_size": 123,
"available_ram_size": 123,
"assigned": true,
"project_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"plan": {
"name": "<string>",
"code_name": "<string>",
"description": "<string>",
"plan_type": "<string>",
"ram_size": 123,
"disk_size": 123,
"cpu_size": 123,
"unit_price": 123
},
"components": [
{
"name": "<string>",
"code_name": "<string>",
"unit_price": 123
}
]
},
"region": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"addons": [
{
"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"
}
}
}
],
"cronjobs": [
{
"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"
}
}
}
]
}Apps
Create a new application
Creates a new application in the specified project. You can choose between auto detection (Miget Buildpacks) for automatic build detection, Dockerfile for custom container builds, or custom builder for language-specific build detection.
POST
/
api
/
v1
/
apps
Create a new application
curl --request POST \
--url https://app.miget.com/api/v1/apps \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"name": "<string>",
"project_id": "<string>",
"resource_id": "<string>",
"ram_size": 123,
"cpu_size": 123,
"private_access": true,
"deployment_config": {
"credential_id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"repository": "<string>",
"repository_url": "<string>",
"branch": "<string>",
"dockerfile_path": "<string>",
"build_context": "<string>",
"project_path": "<string>",
"run_command": "<string>",
"language": "<string>",
"build_command": "<string>",
"pre_deploy_command": "<string>",
"post_deploy_command": "<string>",
"use_dhi": true,
"auto_deploy_enabled": true,
"auto_deploy_branch": "<string>",
"parent_app_id": "<string>",
"parent_image_auto_sync": true,
"ssh_keys": [
"<string>"
],
"command": [
"<string>"
],
"args": [
"<string>"
]
},
"app_vars_attributes": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://app.miget.com/api/v1/apps"
payload = {
"label": "<string>",
"name": "<string>",
"project_id": "<string>",
"resource_id": "<string>",
"ram_size": 123,
"cpu_size": 123,
"private_access": True,
"deployment_config": {
"credential_id": "<string>",
"image_url": "<string>",
"tag": "<string>",
"repository": "<string>",
"repository_url": "<string>",
"branch": "<string>",
"dockerfile_path": "<string>",
"build_context": "<string>",
"project_path": "<string>",
"run_command": "<string>",
"language": "<string>",
"build_command": "<string>",
"pre_deploy_command": "<string>",
"post_deploy_command": "<string>",
"use_dhi": True,
"auto_deploy_enabled": True,
"auto_deploy_branch": "<string>",
"parent_app_id": "<string>",
"parent_image_auto_sync": True,
"ssh_keys": ["<string>"],
"command": ["<string>"],
"args": ["<string>"]
},
"app_vars_attributes": [
{
"key": "<string>",
"value": "<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({
label: '<string>',
name: '<string>',
project_id: '<string>',
resource_id: '<string>',
ram_size: 123,
cpu_size: 123,
private_access: true,
deployment_config: {
credential_id: '<string>',
image_url: '<string>',
tag: '<string>',
repository: '<string>',
repository_url: '<string>',
branch: '<string>',
dockerfile_path: '<string>',
build_context: '<string>',
project_path: '<string>',
run_command: '<string>',
language: '<string>',
build_command: '<string>',
pre_deploy_command: '<string>',
post_deploy_command: '<string>',
use_dhi: true,
auto_deploy_enabled: true,
auto_deploy_branch: '<string>',
parent_app_id: '<string>',
parent_image_auto_sync: true,
ssh_keys: ['<string>'],
command: ['<string>'],
args: ['<string>']
},
app_vars_attributes: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://app.miget.com/api/v1/apps', 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/apps",
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([
'label' => '<string>',
'name' => '<string>',
'project_id' => '<string>',
'resource_id' => '<string>',
'ram_size' => 123,
'cpu_size' => 123,
'private_access' => true,
'deployment_config' => [
'credential_id' => '<string>',
'image_url' => '<string>',
'tag' => '<string>',
'repository' => '<string>',
'repository_url' => '<string>',
'branch' => '<string>',
'dockerfile_path' => '<string>',
'build_context' => '<string>',
'project_path' => '<string>',
'run_command' => '<string>',
'language' => '<string>',
'build_command' => '<string>',
'pre_deploy_command' => '<string>',
'post_deploy_command' => '<string>',
'use_dhi' => true,
'auto_deploy_enabled' => true,
'auto_deploy_branch' => '<string>',
'parent_app_id' => '<string>',
'parent_image_auto_sync' => true,
'ssh_keys' => [
'<string>'
],
'command' => [
'<string>'
],
'args' => [
'<string>'
]
],
'app_vars_attributes' => [
[
'key' => '<string>',
'value' => '<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/apps"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\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/apps")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.miget.com/api/v1/apps")
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 \"label\": \"<string>\",\n \"name\": \"<string>\",\n \"project_id\": \"<string>\",\n \"resource_id\": \"<string>\",\n \"ram_size\": 123,\n \"cpu_size\": 123,\n \"private_access\": true,\n \"deployment_config\": {\n \"credential_id\": \"<string>\",\n \"image_url\": \"<string>\",\n \"tag\": \"<string>\",\n \"repository\": \"<string>\",\n \"repository_url\": \"<string>\",\n \"branch\": \"<string>\",\n \"dockerfile_path\": \"<string>\",\n \"build_context\": \"<string>\",\n \"project_path\": \"<string>\",\n \"run_command\": \"<string>\",\n \"language\": \"<string>\",\n \"build_command\": \"<string>\",\n \"pre_deploy_command\": \"<string>\",\n \"post_deploy_command\": \"<string>\",\n \"use_dhi\": true,\n \"auto_deploy_enabled\": true,\n \"auto_deploy_branch\": \"<string>\",\n \"parent_app_id\": \"<string>\",\n \"parent_image_auto_sync\": true,\n \"ssh_keys\": [\n \"<string>\"\n ],\n \"command\": [\n \"<string>\"\n ],\n \"args\": [\n \"<string>\"\n ]\n },\n \"app_vars_attributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"label": "<string>",
"state": "<string>",
"project_id": "<string>",
"deployment_method": "<string>",
"deployment_config": {},
"builder": "<string>",
"manage_dns_records": true,
"maintenance": true,
"private_access": true,
"service_name": "<string>",
"internal_url": "<string>",
"public_url": "<string>",
"allow_connections": true,
"basic_auth_enabled": true,
"quota": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"miget": {
"uuid": "<string>",
"name": "<string>",
"state": "<string>",
"labels": [
"<string>"
],
"total_disk_size": 123,
"total_ram_size": 123,
"total_cpu_size": 123,
"total_used_disk_size": 123,
"total_used_ram_size": 123,
"total_used_cpu_size": 123,
"available_cpu_size": 123,
"available_disk_size": 123,
"available_ram_size": 123,
"assigned": true,
"project_ids": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"plan": {
"name": "<string>",
"code_name": "<string>",
"description": "<string>",
"plan_type": "<string>",
"ram_size": 123,
"disk_size": 123,
"cpu_size": 123,
"unit_price": 123
},
"components": [
{
"name": "<string>",
"code_name": "<string>",
"unit_price": 123
}
]
},
"region": {
"id": 123,
"name": "<string>",
"code": "<string>"
},
"addons": [
{
"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"
}
}
}
],
"cronjobs": [
{
"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
Bearer token for authentication. Format: 'Bearer {token}'
Headers
Workspace ID (uses default workspace if not provided)
Body
application/json
Create a new application
Human-readable display name for the application
Name seed (used in URLs and DNS). Must be lowercase, alphanumeric with hyphens. A random suffix is appended, so read name back from the response rather than reusing this value.
UUID of the project to create the application in
UUID of the compute resource (Miget) to assign. The app's region is derived from this resource.
Build strategy: 'auto' for automatic buildpack detection, 'dockerfile' for custom Dockerfile builds, 'custom' for language-specific builder
Available options:
auto, dockerfile, custom RAM allocation in MiB (e.g., 256, 512, 1024)
CPU allocation in cores (e.g., 0.5, 1.0, 2.0)
Restrict the app to private access only (no public ingress; default false)
Deployment method: 'git_push', 'public_git', 'github', 'container_registry', 'parent_image', or 'kamal'
Available options:
git_push, parent_image, container_registry, github, public_git, kamal, static_site Deployment configuration (fields depend on deployment_method)
Show child attributes
Show child attributes
Environment variables to set on the app
Show child attributes
Show child attributes
Response
Create a new application
Api_V1_Entities_App model
Unique application identifier
Server-assigned name: the name sent at creation plus a random suffix (my-api-x7k2p). Used in the public URL and the git_push repository path. Use this value verbatim, not the name you sent and not service_name
Display name
Current state. While provisioning: pending, assigned, start_scheduled, started, deploying, cloning, stop_scheduled, restart_scheduled, stopped, blocked. Once started, the live Kubernetes status: running, failed, or problem (pods failing while replicas are up)
Associated project UUID
Deployment method (git_push, public_git, github, container_registry, parent_image, kamal)
Deployment configuration (fields vary by deployment method)
Build strategy (auto, dockerfile, custom)
Auto DNS management enabled
Maintenance mode enabled
Private access only (no public ingress)
Unsuffixed name, used only in internal_url. Not valid in public URLs or git remotes — use name there
Internal service URL (host:port) for app-to-app connections
Platform-assigned public URL, built from the app name and the region of its compute resource. Not reachable when private_access is true. Custom domains are listed separately under /apps/{uuid}/domains
Allow internal connections
Whether HTTP Basic Auth is enforced on the ingress (credentials are never returned)
Resource quota configuration
Creation timestamp
Last update timestamp
Api_V1_Entities_Resource model
Show child attributes
Show child attributes
Api_V1_Entities_Region model
Show child attributes
Show child attributes
Attached add-ons
Show child attributes
Show child attributes
Scheduled cron jobs
Show child attributes
Show child attributes
⌘I