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!)
| Argument | Type | Description |
|---|---|---|
description | String | Additional notes about the Instance. |
name | String | The name of the Instance. |
integration | ID | The Integration that has been deployed for the Instance. |
enabled | Boolean | Specifies whether the Instance is currently enabled and in an executable state. |
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. |
preserveDeployState | Boolean | Specifies whether to update the value of needsDeploy as part of the mutation or leave its current value unaltered. |
configMode | String | Desired configuration mode. |
logsDisabled | Boolean | This field is deprecated. |
stepResultsDisabled | Boolean | This field is deprecated. |
starred | Boolean | Indicates whether the record is starred by the signed-in User. |
id | ID | The ID of the Instance to mutate. |
clientMutationId | String | A unique identifier for the client performing the mutation. |