Skip to main content

copyInstance

form schema

Copy configuration from one instance to another.

Both instances must be built from the same component. Source params (minus any fields the bundle marks non-copyable) are written to the destination, deep-merged with any overrides. A plan deployment is then created on the destination so the caller can review the changes before applying them. copySecrets and copyRemoteReferences opt in to additional state transfer.

mutation {
  copyInstance(
    organizationId: "my-org"
    sourceId: "ecomm-prod-db"
    destinationId: "ecomm-staging-db"
    input: { overrides: { size: "small" }, copySecrets: true, message: "Promote prod config" }
  ) {
    result { id params }
    successful
  }
}
copyInstance(
  organizationId: ID!
  sourceId: ID!
  destinationId: ID!
  input: CopyInstanceInput!
): InstancePayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

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

Your organization's unique identifier.

copyInstance.sourceId ● ID! non-null scalar {#source-id}​

The instance to copy configuration from.

copyInstance.destinationId ● ID! non-null scalar {#destination-id}​

The instance to copy configuration into. Must be built from the same component as the source.

copyInstance.input ● CopyInstanceInput! non-null input {#input}​

Copy configuration from one instance to another. The source and destination must be instances of the same component. Source params (minus any fields marked non-copyable in the bundle) are written to the destination, then a plan deployment is created on the destination so the changes can be reviewed before applying.

Type​

InstancePayload object​