← All resources

Resource

integration_instance

An integration instance (live installation of a definition)

GraphQL reference →

Configuration

idIntegrationInstanceID!OptionalSet on creation

Optional instance ID

set once, at creation

nameString!Required

Instance name (required)

descriptionStringOptional

Optional description

definitionIdIntegrationDefinitionID!Required

Integration definition ID (required)

References integration_definition

botUserIdUserIDOptional

Bot user to run this integration (optional)

References service_account

configString!Required

JSON-encoded configuration (required)

bindingsString!Required

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

JSON text, compared as data: key order and whitespace are not changes

Read-only values

Show values
tenantIdTenantID!Read only

Tenant ID

computed by the platform

integrationIntegrationRead only

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

computed by the platform

integrationIdString!Read only

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

computed by the platform

versionString!Read only

Version of the definition this instance is using

computed by the platform

statusIntegrationInstanceStatus!Read only

Current status

Allowed values

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

computed by the platform

secrets[IntegrationSecretStatus!]!Read only

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

computed by the platform

operationalStateIntegrationOperationalState!Read only

Operational state (health, last run, etc.)

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. Its identity is id.

When replacement is needed, the existing resource is removed before its replacement is created.