Skip to main content

instance Query

Returns 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_admin_instance_permissions, org_manage_instances, org_view_instances]. 2. The signed-in User has any of the following permissions for the object: [instance_admin_permissions, instance_view, instance_edit, instance_remove]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_instance_permissions, customer_view_instances, customer_manage_marketplace_integrations]. 4. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_access_marketplace_integrations]. 5. 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]. 6. 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#

ArgumentTypeDescription
idID!The ID of the Instance object.

Return fields (Instance)#

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.

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.

starred (Boolean)#

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

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.