Skip to main content

createDeployment

form schema

Create a new deployment for an instance.

Saves the provided params as the instance's configuration, then initiates the specified action:

  • PROVISION — apply the configuration to create or update infrastructure.
  • PLAN — generate a dry-run preview without making changes.
  • DECOMMISSION — destroy all infrastructure managed by the instance.

The returned deployment starts in PENDING status and transitions to RUNNING once execution begins. Poll the deployment query or use the status field to monitor progress.

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

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

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

Your organization's unique identifier.

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

The instance to deploy.

createDeployment.input ● CreateDeploymentInput! non-null input {#input}​

Deploy an instance with configuration parameters. Params are validated against the bundle's params schema, cached on the instance, and snapshotted into the deployment.

Type​

DeploymentPayload object​