Skip to main content

updateInstance

form schema

Update an instance's version constraint.

version is a VersionConstraint scalar: a pinned semver (e.g., 1.2.3) or a release channel name as listed by ociRepo.releaseChannels (e.g., latest, ~1.2, ~1.2+dev). See the VersionConstraint scalar for the full grammar.

Changes are staged and take effect on the next deployment. resolvedVersion reflects the new constraint immediately; deployedVersion stays put until a deploy runs.

mutation {
updateInstance(
organizationId: "my-org"
id: "my-database"
input: { version: "~2.0" }
) {
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. Changes take effect on the next deployment.

Type

InstancePayload object