Workflow 10: Create Integration Instance
You are at https://api.litmus.io/workflows/create-integration-instance.md Parent: https://api.litmus.io/workflows/agents.md If this is the wrong workflow, back out to the index above.
10. Create Integration Instance
UI trigger: Integration -> Add Connector -> Select Provider -> Configure -> Save
The Integration module (internally cc) connects Litmus Edge to cloud services and databases. Creating an instance requires knowing the provider's config schema first, then supplying the correct fields in a CreateInstance mutation.
Step table
| Step | API Name | Method | Endpoint / GraphQL Operation | Input | Output / What to capture |
|---|---|---|---|---|---|
| 1 | Get Provider Schema | POST |
{{edgeUrl}}/cc/v2 -> GetProviderSchema |
Provider ID | Full config schema (field names, types, required, defaults, enums). See Provider Schemas - Reference folder for all 64 provider entries. |
| 2 | Create Instance | POST |
{{edgeUrl}}/cc/v2 -> CreateInstance |
Provider ID + Config JSON (matching schema from step 1) | InstanceID, ProviderID, Online, Status. See Create Instance - Provider Examples folder for all 64 provider entries. |
| 3 | List Instances | POST |
{{edgeUrl}}/cc/v2 -> ListInstances |
Optional filter by InstanceID | Verify instance was created, check Online and Status |
| 4 | Create Subscription (topics) | POST |
{{edgeUrl}}/cc/v2 -> CreateSubscriptions |
Instance ID + topic config | Topic subscription created - data starts flowing |
Reference folders: The collection includes Provider Schemas - Reference (64 entries, one per provider with full GetProviderSchema response) and Create Instance - Provider Examples (64 entries, one per provider with CreateInstance mutation + sample config). Entries suffixed
(Gen 1)are the legacy first-generation connectors; unsuffixed entries are the current generation. Use these to look up the exact config fields for any provider.Supported providers (29 current, plus 35 legacy
(Gen 1)variants): AMQP, Aveva DataHub, AWS IoT Core, AWS IoT SiteWise / SiteWise Edge, Azure Event Hubs, Azure IoT Hub, Cognite, Databricks Zerobus Ingest, Google Cloud Pub/Sub, InfluxDB v3, Kafka, Litmus Unify, MaintainX API, Microsoft SQL Server, MongoDB v4+, MQTT (Generic, v5 Generic, IBM Watson over SSL), MySQL, NATS, Oracle Smart Operations in Fusion Cloud SCM, OSI PI Historian, PostgreSQL, REST API, SAP Hana Cloud, Snowflake Snowpipe Stream, Splunk, TimescaleDB.