Skip to main content

updateInstance Mutation

Updates the specified Instance object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_instances]. 2. The signed-in User has any of the following permissions for the object: [instance_edit]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_manage_instances, customer_manage_marketplace_integrations]. 4. The signed-in User has any of the following permissions for the object's 'integration' attribute: [integration_admin_permissions, integration_view, integration_edit, integration_remove]. 5. The signed-in User has any of the following permissions for the object's 'integration_Customer' attribute: [customer_admin_manage_instances, customer_admin_integration_permissions, customer_manage_integrations].

Input fields (UpdateInstanceInput!)

ArgumentTypeDescription
descriptionStringAdditional notes about the Instance.
nameStringThe name of the Instance.
integrationIDThe Integration that has been deployed for the Instance.
enabledBooleanSpecifies whether the Instance is currently enabled and in an executable state.
logsDisabledBooleanSpecifies whether to disable the creation of logs during Instance execution.
stepResultsDisabledBooleanSpecifies whether to disable the creation of step results during Instance execution.
labels[String]The labels that are associated with the object.
configVariables[InputInstanceConfigVariable]The Instance with which the Config Variable is associated.
flowConfigs[InputInstanceFlowConfig]The configuration for the IntegrationFlow associated with the Instance.
preserveDeployStateBooleanSpecifies whether to update the value of needsDeploy as part of the mutation or leave its current value unaltered.
configModeStringDesired configuration mode.
starredBooleanIndicates whether the record is starred by the signed-in User.
idIDThe ID of the Instance to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateInstancePayload)

clientMutationId (String)
errors ([ErrorType!]!)
instance (Instance)