← All types
Ob Object

IntegrationInstanceState

An integration instance (live installation of a definition)

Fields

Unique identifier

Tenant ID

name

String!Non-null

User-provided name for this instance

Optional description

Reference to the integration definition. Changing it upgrades the instance.

The integration this instance is installed from. Its publishedVersion is the default for new installs; this instance stays on definitionId until it is upgraded.

Integration identifier (e.g., com.acme.erp-connector)

version

String!Non-null

Version of the definition this instance is using

Current status

Possible values (4)
ACTIVE

Enabled for execution. Consult operationalState.health for observed runtime health; ACTIVE alone does not prove the runtime is running.

PAUSED

Paused, not running

ERROR

In error state

UPGRADING

Being upgraded to a new version

Bot user assigned to run this integration

config

String!Non-null

User configuration (JSON). Secret keys are omitted — see secrets.

Per-key state of this instance's secrets: which are set and when each last changed. Never carries a value.

Resource bindings as a JSON object keyed by resource id. Each value is the bound entity's TypeID; an extension bound with a service account is { "script": "scr_…", "runAs": "usr_…" }.

Operational state (health, last run, etc.)

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

Referenced by (3)
Exact type SDL
"""An integration instance (live installation of a definition)"""
type IntegrationInstanceState @iac_resource(name: "integration_instance") @iac_ops(create: "createIntegrationInstance", read: "getIntegrationInstance", update: "updateIntegrationInstance", delete: "deleteIntegrationInstance") @iac_writeGroup(name: "upgrade", operation: "upgradeIntegrationInstance", trigger: ["definitionId"], note: "stops the instance, runs the new version's upgrade hook, and starts it again") {
  """Unique identifier"""
  id: IntegrationInstanceID! @iac_identity(assignedBy: USER) @iac_createOnly
  """Tenant ID"""
  tenantId: TenantID! @iac_computed
  """User-provided name for this instance"""
  name: String!
  """Optional description"""
  description: String
  """
  Reference to the integration definition. Changing it upgrades the instance.
  """
  definitionId: IntegrationDefinitionID! @iac_ref(resource: "integration_definition") @iac_groupInput(group: "upgrade", path: "input.toDefinitionId")
  """
  The integration this instance is installed from. Its publishedVersion is the default for new installs; this instance stays on definitionId until it is upgraded.
  """
  integration: Integration @iac_computed
  """Integration identifier (e.g., com.acme.erp-connector)"""
  integrationId: String! @iac_computed
  """Version of the definition this instance is using"""
  version: String! @iac_computed
  """Current status"""
  status: IntegrationInstanceStatus! @iac_computed
  """Bot user assigned to run this integration"""
  botUserId: UserID @iac_ref(resource: "service_account")
  """User configuration (JSON). Secret keys are omitted — see `secrets`."""
  config: String! @iac_artifact(language: JSON, validators: ["integration-config"]) @iac_groupInput(group: "upgrade", path: "input.configOverrides")
  """
  Per-key state of this instance's secrets: which are set and when each last changed. Never carries a value.
  """
  secrets: [IntegrationSecretStatus!]! @iac_computed
  """
  Resource bindings as a JSON object keyed by resource id. Each value is the bound entity's TypeID; an extension bound with a service account is { "script": "scr_…", "runAs": "usr_…" }.
  """
  bindings: String! @iac_compare(as: JSON) @iac_groupInput(group: "upgrade", path: "input.bindings")
  """Operational state (health, last run, etc.)"""
  operationalState: IntegrationOperationalState! @iac_computed
  """Creation timestamp (ISO8601)"""
  createdAt: String! @iac_computed
  """Last update timestamp (ISO8601)"""
  updatedAt: String! @iac_computed
}