---
title: Create Integration Instance
slug: api-docs/create-integration-instance
docTags: 
createdAt: 2026-05-11T22:14:10.115Z
---

# 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. |
| 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.              |
| 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` -> `CreateSubscription` | Instance ID + topic config                              | Topic subscription created - data starts flowing                                                                 |

## Reference sections

`api.litmus.io` includes two cross-referenced sections, one entry per provider:

- **Provider Schemas - Reference** (45 entries) - canonical `GetProviderSchema` response per provider. Use as a lookup for valid config fields.
- **Create Instance - Provider Examples** (45 entries) - canonical `CreateInstance` mutation per provider, with a working config body. Copy and adapt.

## Supported providers (45)

AMQP (SSL/TCP), Aveva Data Hub, OSI PI Historian, AWS IoT Core/SiteWise, Azure Event Hubs/IoT Hub, Cognite, Databricks SQL, Google Cloud Pub/Sub, IBM Watson, InfluxDB (v1.7/v2), Kafka (SSL/TCP, Gen 2), Litmus UNS, MQTT (Generic/v5/SSL), MongoDB (v4+), NATS, Oracle Fusion Cloud, REST API, SQL Server, MySQL, PostgreSQL, Snowflake, Splunk.

## See also

- [Integration Providers concept](#)
- [Integration reference](#)