PUT
/
api
/
v1
/
apps
/
{uuid}
/
deployment
Update application deployment configuration
curl --request PUT \
  --url https://app.miget.com/api/v1/apps/{uuid}/deployment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deployment_method": "git_push",
  "deployment_config_attributes": {
    "image_url": "<string>",
    "tag": "<string>",
    "parent_app_id": "<string>",
    "parent_image_auto_sync": true,
    "container_registry_credential_id": "<string>",
    "ssh_keys": [
      "<string>"
    ]
  }
}
'
{
  "uuid": "<string>",
  "name": "<string>",
  "label": "<string>",
  "state": "<string>",
  "project_id": "<string>",
  "deployment_method": "<string>",
  "deployment_config": {},
  "builder": "<string>",
  "manage_dns_records": true,
  "maintenance": true,
  "service_name": "<string>",
  "allow_connections": 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,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "plan": {
      "name": "<string>",
      "code_name": "<string>",
      "description": "<string>",
      "ram_size": 123,
      "disk_size": 123,
      "cpu_size": 123,
      "unit_price": 123
    },
    "components": [
      {
        "name": "<string>",
        "code_name": "<string>",
        "unit_price": 123
      }
    ]
  },
  "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

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

uuid
string
required

Application UUID

Body

application/json

Update application deployment configuration

deployment_method
enum<string>
required

Deployment method: 'git_push' for Git-based deployments, 'docker_registry' for container registry, 'parent_image' for image inheritance, 'kamal' for Kamal deployments

Available options:
git_push,
parent_image,
container_registry,
github,
public_git,
kamal
deployment_config_attributes
object

Kamal deployment configuration

Response

Update application deployment configuration

Api_V1_Entities_App model

uuid
string
required

Unique application identifier

name
string
required

Service name (used in URLs)

label
string
required

Display name

state
string
required

Current state (pending, running, stopped, etc.)

project_id
string
required

Associated project UUID

deployment_method
string
required

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

deployment_config
object
required

Deployment configuration (fields vary by deployment method)

builder
string
required

Build strategy (auto, dockerfile, custom)

manage_dns_records
boolean
required

Auto DNS management enabled

maintenance
boolean
required

Maintenance mode enabled

service_name
string
required

Internal service name

allow_connections
boolean
required

Allow internal connections

quota
object
required

Resource quota configuration

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

addons
object[]
required

Attached add-ons

cronjobs
object[]
required

Scheduled cron jobs