Skip to main content

updateInstance

form schema

Update an instance's version constraint or release strategy.

Changes are staged and take effect on the next deployment. The resolvedVersion field will reflect the new constraint immediately, while deployedVersion remains unchanged until a deploy runs.

mutation {
  updateInstance(
    organizationId: "my-org"
    id: "my-database"
    input: { version: "~2.0", releaseStrategy: stable }
  ) {
    result { id resolvedVersion }
    successful
  }
}
updateInstance(
  organizationId: ID!
  id: ID!
  input: UpdateInstanceInput!
): InstancePayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

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

Your organization's unique identifier.

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

The instance ID to update.

updateInstance.input ● UpdateInstanceInput! non-null input {#input}​

Update an instance's version constraint or release strategy. Changes take effect on the next deployment.

Type​

InstancePayload object​