Start or resume an application deploy run

Hand the deploy wizard’s whole ordered multi-stack deploy to the server. The run is persisted before anything is created - roles, drafts, and the stack name derived for each - and the maintenance supervisor creates each stack in turn, waiting for every stack that has another behind it to report up. Closing the browser tab no longer strands the remaining stacks. A request made while a run for the same application and cluster is already in flight joins that run and answers with resumed=true rather than starting a rival queue. Browser session authentication with the X-Ankra-CSRF double-submit header only (no bearer twin).

POST /org/applications/{application_id}/deploy-runs

Start or resume an application deploy run

Python

import requests

url = "https://platform.ankra.app/org/applications/{application_id}/deploy-runs"

payload = {
    "cluster_id": "<string>",
    "roles": [
        {
            "role": "<string>",
            "draft_id": "<string>",
            "stack_name": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "cluster_id": "<string>",
  "status": "<string>",
  "message": "<string>",
  "resumed": true,
  "divergence": "<string>",
  "roles": [
    {
      "role": "<string>",
      "position": 123,
      "draft_id": "<string>",
      "stack_name": "<string>",
      "created_stack_name": "<string>",
      "operation_id": "<string>",
      "status": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id · string · required

Body

application/json

cluster_id · string · required

roles · DeployRunRoleRequest · object[] · required

The queue in deploy order: platform stacks first, the application stack last.

Show child attributes

namespace · string

Where the application's workload lands on this cluster. The application role's stack deploys the manifests committed under .ankra/manifests, rendered into this namespace; a run that omits it promotes its designed stacks unchanged.

deploy_mode · string

Sizing the deploy chose ('quick' or 'high_availability'). Omitted is default sizing.

parameters · Parameters · object

Answers to the application's option contract that no repository can hold - the ingress host and class this cluster publishes it on. Options the contract declares a default for, and the image tag of the application's own most recent successful publish, are resolved at render time and need not be sent.

Show child attributes

Response

200

application/json

Successful Response

id · string · required

cluster_id · string · required

status · string · required

pending, running, succeeded, or failed.

message · string | null · required

resumed · boolean · required

True when the request joined a run that was already in flight instead of starting a new one.

divergence · string | null · required

How a resumed run differs from the queue the request carried (a role not in the run, a role deploying a different stack name or draft, or a differing role count). Null when the request asked for what is already in flight, and always null on a run this request started.

roles · DeployRunRole · object[] · required

Show child attributes