moveInstance

form schema

Move an instance to an environment in another project.

The instance keeps its configuration, secrets, state, resources, and deployment history. Its identifier changes to the destination environment and component; its name prefix does not. The source component stays on its blueprint, and its instance in the source environment is reset to a new INITIALIZED instance.

The destination component's instance in that environment must be INITIALIZED or DECOMMISSIONED, and the moved instance replaces it. If the destination project has no component with componentId, the move adds one for the same bundle. A component with that ID that uses a different bundle is an error.

Links across the move become remote references, and each resource is granted to the environment that uses it when no grant covers that environment yet.

Requires instance:move on the instance before and after the move, plus every permission for what the move creates: project:design to add the component, instance:configure and resource:view for each remote reference, and resource:grant for each new grant. The move completes fully or fails; a failed move changes nothing and returns every reason in messages.

Cloud tags and identifiers change with the move. Deploy the instance afterwards to bring your cloud resources in sync.

mutation {
  moveInstance(
    organizationId: "my-org"
    id: "billing-prod-vpc"
    environmentId: "network-prod"
    componentId: "vpc"
    input: { preserveHistory: true }
  ) {
    result { id status }
    successful
    messages { message }
  }
}

moveInstance(
  organizationId: ID!
  id: ID!
  environmentId: ID!
  componentId: ID!
  input: MoveInstanceInput!
): InstancePayload

Form Schema

This mutation supports dynamic form generation using JSON Schema.

• JSON Schema
• UI Schema

Loading schema...

Arguments

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

Your organization's unique identifier.

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

The instance to move.

moveInstance.environmentId ● ID! non-null scalar {#environment-id}

The environment, in another project, to move the instance into.

moveInstance.componentId ● ID! non-null scalar {#component-id}

The component in the destination project that the instance belongs to after the move, without the project prefix (for example vpc, not network-vpc). Max 20 characters, lowercase alphanumeric only.

moveInstance.input ● MoveInstanceInput! non-null input {#input}

Move an instance, with its configuration, state, and deployment history, to an environment in another project.

Type

InstancePayload object