instance

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's 'customer' attribute: [customer_admin_instance_permissions, customer_view_instances]. 3. The signed-in User has any of the following permissions for the object: [instance_admin_permissions, instance_view, instance_edit, instance_remove].

Input fields

ArgumentTypeDescription
idID!The ID of the Instance object.

Return fields (Instance)

id (ID!)

The ID of the object.

labels ([String])

The labels that are associated with the object.

name (String!)

The name of the Instance.

customer (Customer!)

The Customer for which the Instance is deployed.

integration (Integration!)

The Integration that has been deployed for the Instance.

description (String!)

Additional notes about the Instance.

enabled (Boolean!)

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

lastDeployedAt (DateTime)

The timestamp at which the Instance was most recently deployed.

deployedVersion (Int!)

The specific version of the Instance that is deployed.

systemSuspended (Boolean!)

Specifies whether the Instance has been suspended by Prismatic.

inFailedState (Boolean!)

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

monitors (AlertMonitorConnection!)

The Instance that is being monitored by the AlertMonitor.

configVariables (InstanceConfigVariableConnection!)

The Instance with which the Config Variable is associated.

credentials (InstanceCredentialConnection!)

The Instance with which the Credential is associated.

executionResults (InstanceExecutionResultConnection!)

The Instance being executed.

logs (LogConnection!)

The Instance which created the Log entry.

triggerUrl (String!)

The URL of the endpoint that triggers execution of the Instance.

lastExecutedAt (DateTime)

The timestamp at which the Instance last executed.

apiKey (String)

An optional API Key that, when specified, will be required as a header value in all requests to trigger Instance execution.

allowUpdate (Boolean!)

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

allowRemove (Boolean!)

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

starred (Boolean)

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

Last updated on