Deploy an application

Preserves omitted installation options. reset_inputs deliberately removes named overrides so repository defaults apply. Returns a durable operation identity.

POST /api/v1/org/applications/{application_id}/deploy

Deploy an application

Python

import requests

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

payload = { "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

200

{
  "installation_id": "<string>",
  "operation_id": "<string>",
  "status": "<string>",
  "message": "<string>",
  "warnings": [
    "<string>"
  ],
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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<uuid> · required

namespace · string

deploy_mode · enum<string>

Available options: quick, high_availability

inputs · object

Show child attributes

reset_inputs · string[]

Explicitly remove stored overrides for declared options with repository defaults. Cannot overlap inputs.

environment_name · string

Name a new environment for this deployment. Trimmed; 1 to 100 characters with no control characters. Accepted only on a cluster where the application has no deployment in any namespace and no cluster-scoped secrets, and only when no other environment of the application has the same name ignoring case; otherwise 409 with an error_code. Omitted or null deploys exactly as before, creating no environment.

Required string length: 1 - 100

Response

200

application/json

Successful Response

installation_id · string · required

operation_id · string · required

status · string · required

message · string · required

warnings · string[]

Things the deploy went ahead with anyway that the caller needs to know - today, an application that deploys a database whose backup default could not be armed. Absent when there are none, so a deploy with nothing to say answers exactly what it always did; never a reason the deploy did not start.

environment_id · string<uuid>

The environment a deploy that named one created and bound the new deployment to. Absent when the request named no environment.