Skip to main content
POST
Deploy an application

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
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
prepare_database
boolean

Consent that the deploy sets up the CloudNativePG operator the application's database needs when the cluster has none: Ankra installs its cloudnative-pg platform profile on the cluster before the deploy is queued, and the deploy waits for it. Requires stacks.write on the cluster. Without it the operator is set up only where the environment's autonomy is Ankra runs it; otherwise such a deploy is refused with the set_up_database remedy.

Response

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.