Skip to main content

proposeDeployment

form schema

Propose a deployment for human review.

Creates a deployment in PROPOSED status. Proposed deployments are not scheduled and do not block the queue — other deployments on the same instance can continue to run while a proposal is outstanding.

Approve a proposal with approveDeployment to release it into the run queue, or discard it with rejectDeployment.

Only PROVISION and DECOMMISSION actions are proposable — PLAN is already a non-destructive preview and needs no approval gate.

mutation {
  proposeDeployment(
    organizationId: "my-org"
    id: "my-database"
    input: { action: PROVISION, params: { size: "large" }, message: "Scale up for Black Friday" }
  ) {
    result { id status action }
    successful
    messages { field message }
  }
}
proposeDeployment(
  organizationId: ID!
  id: ID!
  input: ProposeDeploymentInput!
): DeploymentPayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

proposeDeployment.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

proposeDeployment.id ● ID! non-null scalar {#id}​

The instance to propose a deployment for.

proposeDeployment.input ● ProposeDeploymentInput! non-null input {#input}​

Propose a deployment for human review. The deployment is created in PROPOSED status and will not execute until it is approved via approveDeployment. Params are validated against the bundle's params schema and snapshotted into the proposal.

Type​

DeploymentPayload object​