Skip to main content

planDeployment

Run a fresh PLAN against an existing deployment's params.

The source deployment's params are copied (without md_metadata) onto a new deployment with action PLAN, which runs as a dry-run preview. Nothing on the source deployment, the instance's saved configuration, or any other deployment is mutated. The plan's message is synthesized from the source so the preview is traceable back to what it was run against.

The source can be in any status — useful for previewing a proposal before approving, replaying a completed deployment, or scoping out a rollback against an older snapshot. Authorization is checked with instance:plan on the source's instance.

mutation {
  planDeployment(
    organizationId: "my-org"
    id: "550e8400-e29b-41d4-a716-446655440000"
  ) {
    result { id status action }
    successful
    messages { field message }
  }
}
planDeployment(
  organizationId: ID!
  id: UUID!
): DeploymentPayload

Arguments​

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

Your organization's unique identifier.

planDeployment.id ● UUID! non-null scalar {#id}​

The deployment whose params should be planned.

Type​

DeploymentPayload object​