createInstance

Creates a new 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, org_create_instances].

Input fields (CreateInstanceInput!)

ArgumentTypeDescription
descriptionStringAdditional notes about the Instance.
customerID!The Customer for which the Instance is deployed.
integrationID!The Integration that has been deployed for the Instance.
nameString!The name of the Instance.
credentials[InputInstanceCredential]The Instance with which the Credential is associated.
configVariables[InputInstanceConfigVariable]The Instance with which the Config Variable is associated.
apiKeyStringAn optional API Key that, when specified, will be required as a header value in all requests to trigger Instance execution.
labels[String]The labels that are associated with the object.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (CreateInstancePayload)

instance (Instance)
errors ([ErrorType])
clientMutationId (String)
Last updated on