POST
Create a new application

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 application

label
string
required

Human-readable display name for the application

name
string
required

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.

project_id
string
required

UUID of the project to create the application in

resource_id
string
required

UUID of the compute resource (Miget) to assign. The app's region is derived from this resource.

builder
enum<string>
required

Build strategy: 'auto' for automatic buildpack detection, 'dockerfile' for custom Dockerfile builds, 'custom' for language-specific builder

Available options:
auto,
dockerfile,
custom
ram_size
number<float>

RAM allocation in MiB (e.g., 256, 512, 1024)

cpu_size
number<float>

CPU allocation in cores (e.g., 0.5, 1.0, 2.0)

private_access
boolean

Restrict the app to private access only (no public ingress; default false)

vpc_uuid
string

UUID of a VPC to join on creation. The VPC's default subnet is used unless vpc_subnet_uuid is given. The VPC must be in the same region as the compute resource.

vpc_subnet_uuid
string

UUID of the subnet to join, when a VPC has more than one. Implies its VPC, so vpc_uuid may be omitted.

vpc_static_ip
boolean

Give the app a fixed address on the subnet it joins instead of one that changes whenever its pod is replaced. Ignored unless vpc_uuid or vpc_subnet_uuid is given. The app must run a single replica without autoscaling, and deployments then replace the pod instead of rolling it, which means a short downtime on every deploy. The address is returned by the VPC attachments endpoints (address_v4, and address_v6 when the subnet has an IPv6 range). Defaults to false.

deployment_method
enum<string>

Deployment method: 'git_push', 'public_git', 'github', 'container_registry', 'parent_image', or 'kamal'. 'container_registry' requires a paid plan on the chosen resource; on a free plan the request is rejected with 422.

Available options:
git_push,
parent_image,
container_registry,
github,
public_git,
kamal,
static_site
deployment_config
object

Deployment configuration (fields depend on deployment_method)

app_vars_attributes
object[]

Environment variables to set on the app

Response

Create a new application

Api_V1_Entities_App model

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

region
object
required

Api_V1_Entities_Region model

addons
object[]
required

Attached add-ons

cronjobs
object[]
required

Scheduled cron jobs