latestOpenAPI 3.1.02026-08-1076186318.8 KB

ab648a80ca4d

Applications

Update application basic details

put/applications/{id}

Path parameters

idstring required
Example:54fb80af-576c-4fdc-ba4f-b596c83f15a1

Request body

build_pathstring
build_type'dockerfile' | 'pack' | 'nixpacks'
docker_file_pathstring
docker_contextstring
display_namestring
auto_deployboolean
default_branchstring
hibernation_enabledboolean
hibernate_after_secondsnumber

Example request

{
  "build_path": "dist",
  "build_type": "dockerfile",
  "docker_file_path": "Dockerfile",
  "docker_context": ".",
  "display_name": "My App",
  "auto_deploy": true,
  "default_branch": "main",
  "hibernation_enabled": true,
  "hibernate_after_seconds": 900
}

Response

Application updated successfully

Example response

{
  "app": {
    "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
    "name": "my-app",
    "status": "deploymentInProgress",
    "updated_at": 1695300630620,
    "build_path": "dist",
    "build_type": "dockerfile",
    "docker_file_path": "Dockerfile",
    "docker_context": ".",
    "display_name": "My App",
    "auto_deploy": true,
    "default_branch": "main",
    "hibernation_enabled": true,
    "hibernate_after_seconds": 900
  }
}