Skip to main content

Instance Object

Represents an instance of an Integration which has been deployed in the context of a Customer, to include Config Variable values, Credentials, and a specific version of an Integration.

Return fields

allowDeploy (Boolean)

Specifies whether the signed-in User can deploy the Instance.

allowRemove (Boolean!)

Specifies whether the signed-in User can remove the Instance.

allowUpdate (Boolean!)

Specifies whether the signed-in User can update the Instance.

allowUpdateConfigVariables (Boolean)

Specifies whether the signed-in User can update config variables for the Instance.

configState (InstanceConfigState)

Describes the state of configuration of this Instance.

configVariables (InstanceConfigVariableConnection!)

The Instance with which the Config Variable is associated.

createdAt (DateTime!)

The timestamp at which the object was created.

customer (Customer!)

The Customer for which the Instance is deployed.

deployedVersion (Int!)

The specific version of the Instance that is deployed.

description (String!)

Additional notes about the Instance.

enabled (Boolean!)

Specifies whether the Instance is currently enabled and in an executable state.

executionResults (InstanceExecutionResultConnection!)

The Instance for which a specific InstanceFlowConfig is being executed.

flowConfigs (InstanceFlowConfigConnection!)

The configuration for the IntegrationFlow associated with the Instance.

id (ID!)

The ID of the object

inFailedState (Boolean!)

Specifies whether the latest execution of this Instance resulted in a failure.

integration (Integration!)

The Integration that has been deployed for the Instance.

isCustomerDeployable (Boolean)

Specifies whether the Instance can be deployed through the Marketplace.

isCustomerUpgradeable (Boolean)

Specifies whether the Instance can be upgraded through the Marketplace.

labels ([String!])

The labels that are associated with the object.

lastDeployedAt (DateTime)

The timestamp at which the Instance was most recently deployed.

lastExecutedAt (DateTime)

The timestamp at which the Instance was most recently executed.

logs (LogConnection!)

The Instance which created the Log entry.

logsDisabled (Boolean!)

This field has been deprecated.

monitors (AlertMonitorConnection!)

The Instance that is being monitored by the AlertMonitor.

name (String!)

The name of the Instance.

needsDeploy (Boolean!)

Specifies whether a deploy is needed to reflect the newest configuration for this Instance.

profile (InstanceProfile)

The Instance Profile used by this Instance.

starred (Boolean)

Indicates whether the record is starred by the signed-in User.

stepResultsDisabled (Boolean!)

This field has been deprecated.

systemSuspended (Boolean!)

Specifies whether the Instance has been suspended by Prismatic.

updatedAt (DateTime!)

The timestamp at which the object was most recently updated.

userLevelConfigVariables (CustomUserLevelConfigVariableConnection)

The User Level Config variables for the requesting User on this Instance.

userLevelConfigs (UserLevelConfigConnection!)

The Instance with which the User Level Config is associated.