List project applications

curl --request GET \
  --url https://app.miget.com/api/v1/projects/{project_id}/apps \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.miget.com/api/v1/projects/{project_id}/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/projects/{project_id}/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.miget.com/api/v1/projects/{project_id}/apps"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/projects/{project_id}/apps")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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,
    "basic_auth_username": "<string>",
    "quota": {},
    "ram_size": 123,
    "cpu_size": 123,
    "resource_id": "<string>",
    "vpc_uuid": "<string>",
    "vpc_subnet_uuid": "<string>",
    "project_variables_enabled": true,
    "project_secret_files_enabled": true,
    "health_checks": {},
    "scaling_profile": {},
    "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,
      "region_code": "<string>",
      "component_quantities": [
        {
          "code_name": "1gb-ram",
          "quantity": 2
        }
      ],
      "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": {},
        "ram_size": 123,
        "disk_size": 123,
        "cpu_size": 123,
        "service_id": 123,
        "backup_enabled": true,
        "scheduled_backup": "<string>",
        "role": "<string>",
        "primary_addon_uuid": "<string>",
        "replicas": [
          {}
        ],
        "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": {},
        "ram_size": 123,
        "disk_size": 123,
        "cpu_size": 123,
        "service_id": 123,
        "backup_enabled": true,
        "scheduled_backup": "<string>",
        "role": "<string>",
        "primary_addon_uuid": "<string>",
        "replicas": [
          {}
        ],
        "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"
          }
        }
      }
    ]
  }
]

GET

api

projects

{project_id}

apps

List project applications

curl --request GET \
  --url https://app.miget.com/api/v1/projects/{project_id}/apps \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.miget.com/api/v1/projects/{project_id}/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/projects/{project_id}/apps",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.miget.com/api/v1/projects/{project_id}/apps"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.miget.com/api/v1/projects/{project_id}/apps")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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,
    "basic_auth_username": "<string>",
    "quota": {},
    "ram_size": 123,
    "cpu_size": 123,
    "resource_id": "<string>",
    "vpc_uuid": "<string>",
    "vpc_subnet_uuid": "<string>",
    "project_variables_enabled": true,
    "project_secret_files_enabled": true,
    "health_checks": {},
    "scaling_profile": {},
    "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,
      "region_code": "<string>",
      "component_quantities": [
        {
          "code_name": "1gb-ram",
          "quantity": 2
        }
      ],
      "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": {},
        "ram_size": 123,
        "disk_size": 123,
        "cpu_size": 123,
        "service_id": 123,
        "backup_enabled": true,
        "scheduled_backup": "<string>",
        "role": "<string>",
        "primary_addon_uuid": "<string>",
        "replicas": [
          {}
        ],
        "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": {},
        "ram_size": 123,
        "disk_size": 123,
        "cpu_size": 123,
        "service_id": 123,
        "backup_enabled": true,
        "scheduled_backup": "<string>",
        "role": "<string>",
        "primary_addon_uuid": "<string>",
        "replicas": [
          {}
        ],
        "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

project_id

string

required

Project ID or UUID

Response

List project applications

uuid

string

required

Unique application identifier

name

string

required

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

label

string

required

Display name

state

string

required

Current state. While provisioning: pending, assigned, start_scheduled, started, deploying, cloning, stop_scheduled, restart_scheduled, stopped, blocked. A free-plan app with no recent traffic: sleeping, until the next request wakes it. Once started, the live Kubernetes status: running, failed, or problem (pods failing while replicas are up)

project_id

string

required

Associated project UUID

deployment_method

string

required

Deployment method (git_push, public_git, github, container_registry, parent_image, kamal)

deployment_config

object

required

Deployment configuration (fields vary by deployment method). For container_registry, github and public_git it includes credential_id, the UUID of the stored credential accepted by PUT /apps/{uuid}/deployment, null when none is set

builder

string

required

Build strategy (auto, dockerfile, custom)

manage_dns_records

boolean

required

Auto DNS management enabled

maintenance

boolean

required

Maintenance mode enabled

private_access

boolean

required

Private access only (no public ingress)

service_name

string

required

Unsuffixed name, used only in internal_url. Not valid in public URLs or git remotes — use name there

internal_url

string

required

Internal service URL (host:port) for app-to-app connections

public_url

string

required

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_connections

boolean

required

Allow internal connections

basic_auth_enabled

boolean

required

Whether HTTP Basic Auth is enforced on the ingress (credentials are never returned)

basic_auth_username

string

required

Username for HTTP Basic Auth on the ingress. Null when none is set. The password is never returned

quota

object

required

Raw resource quota row. Use ram_size and cpu_size for the values accepted by POST and PUT /apps

ram_size

number<float>

required

RAM allocation per instance in MiB, the unit POST and PUT /apps accept, rounded to 6 decimal places. Null when the app has no quota

cpu_size

number<float>

required

CPU allocation per instance in cores, the unit POST and PUT /apps accept. Null when the app has no quota

resource_id

string

required

UUID of the assigned compute resource, the value POST /apps accepts as resource_id. Null when none is assigned

vpc_uuid

string

required

UUID of the VPC the app is attached to. Null when not attached

vpc_subnet_uuid

string

required

UUID of the VPC subnet the app is attached to. Null when not attached

project_variables_enabled

boolean

required

Whether the app also receives its project's environment variables

project_secret_files_enabled

boolean

required

Whether the app also mounts its project's secret files. Set via PUT /apps/{uuid}/secret_files/project_files_enabled

health_checks

object

required

Health check settings, keyed by the params of PUT /apps/{uuid}/health_checks: {liveness,readiness,startup}_probe_enabled (boolean), {liveness,readiness,startup}probe_path (string), {liveness,readiness,startup}probe{initial_delay_seconds,timeout_seconds,period_seconds,failure_threshold} (integer) and {liveness,readiness,startup}{in_app,email}_failure_notification_enabled (boolean). Values are those stored for the app; a path or number that was never set is null and a flag that was never set is false

scaling_profile

object

required

Scaling settings, keyed by the params of PUT /apps/{uuid}/scaling_profile: replicas (integer, fixed instance count used when auto_scaling_enabled is false), auto_scaling_enabled (boolean), auto_min_replicas and auto_max_replicas (integer), scaling_start_time and scaling_end_time (HH:MM strings, null when no scheduled window is set), cpu_threshold and memory_threshold (integer percent). When the app has no scaling profile it runs one instance: replicas is 1, auto_scaling_enabled is false and the other keys are null

created_at

string<date-time>

required

Creation timestamp

updated_at

string<date-time>

required

Last update timestamp

miget

object

required

Api_V1_Entities_Resource model

Show child attributes

region

object

required

Api_V1_Entities_Region model

Show child attributes

addons

object[]

required

Attached add-ons

Show child attributes

cronjobs

object[]

required

Scheduled cron jobs

Show child attributes

Overview

Miget API

List project applications

Authorizations

Headers

Path Parameters

Response