Litmus Edge 4.4.x - Integration: Create Instance Provider Examples

Create Instance - AMQP SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 900f51b2-936b-43c2-9af8-d65046f312a5 Provider Name: AMQP SSL

Required properties: - port integer — Port: Port number - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - name string — Name: Instance Name - hostname string — Hostname - routingKey string — Routing key

Optional properties: - exchangeDurable boolean — Exchange durable - exchangeInternal boolean — Exchange internal - exchangeNoWait boolean — Exchange no wait - password string — Password - exchange string — Exchange - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - username string — Username - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - certificate string — Certificate: Certificate can be added here. - exchangeType string — exchangeType: Exchange type Options: direct, fanout, topic, x-custom - iso8601Timestamp boolean — ISO8601 timestamp: Convert timestamp to ISO8601 - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - privateKey string — Private key: Private key can be added here. - throttlingLimit integer — Throttling limit - virtualHost string — Virtual host: Virtual hostname - exchangeAutoDelete boolean — Exchange auto delete

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "900f51b2-936b-43c2-9af8-d65046f312a5",
    "Config": "{\"name\": \"My AMQP SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5671, \"virtualHost\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"password\", \"exchange\": \"placeholder_exchange\", \"exchangeType\": \"direct\", \"exchangeDurable\": true, \"exchangeAutoDelete\": false, \"exchangeInternal\": false, \"exchangeNoWait\": false, \"routingKey\": \"<certificate>\", \"iso8601Timestamp\": false, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "900f51b2-936b-43c2-9af8-d65046f312a5",
            "ProviderName": "AMQP SSL",
            "Config": "{\"name\": \"My AMQP SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5671, \"virtualHost\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"password\", \"exchange\": \"placeholder_exchange\", \"exchangeType\": \"direct\", \"exchangeDurable\": true, \"exchangeAutoDelete\": false, \"exchangeInternal\": false, \"exchangeNoWait\": false, \"routingKey\": \"<certificate>\", \"iso8601Timestamp\": false, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - AMQP TCP (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 800bfae1-9d30-4e90-932c-e646a7771c1b Provider Name: AMQP TCP

Required properties: - routingKey string — Routing key - name string — Name: Instance Name - port integer — Port: Port number - hostname string — Hostname

Optional properties: - exchangeNoWait boolean — Exchange no wait - throttlingLimit integer — Throttling limit - username string — Username - virtualHost string — Virtual host: Virtual hostname - password string — Password - persistentStorage boolean — Persistent storage - exchangeInternal boolean — Exchange internal - exchangeType string — exchangeType: Exchange type Options: direct, fanout, topic, x-custom - iso8601Timestamp boolean — ISO8601 timestamp: Convert timestamp to ISO8601 - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - exchange string — Exchange - exchangeAutoDelete boolean — Exchange auto delete - exchangeDurable boolean — Exchange durable - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "800bfae1-9d30-4e90-932c-e646a7771c1b",
    "Config": "{\"name\": \"My AMQP TCP Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5672, \"virtualHost\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"password\", \"exchange\": \"placeholder_exchange\", \"exchangeType\": \"direct\", \"exchangeDurable\": true, \"exchangeAutoDelete\": false, \"exchangeInternal\": false, \"exchangeNoWait\": false, \"routingKey\": \"<certificate>\", \"iso8601Timestamp\": false, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "800bfae1-9d30-4e90-932c-e646a7771c1b",
            "ProviderName": "AMQP TCP",
            "Config": "{\"name\": \"My AMQP TCP Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5672, \"virtualHost\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"password\", \"exchange\": \"placeholder_exchange\", \"exchangeType\": \"direct\", \"exchangeDurable\": true, \"exchangeAutoDelete\": false, \"exchangeInternal\": false, \"exchangeNoWait\": false, \"routingKey\": \"<certificate>\", \"iso8601Timestamp\": false, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Aveva Data Hub (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 1486437a-8208-4ec8-bb50-cf7f394fcf51 Provider Name: Aveva Data Hub

Required properties: - endpoint string — Endpoint - namespace string — Namespace - stream string — Stream Id - name string — Name: Instance Name - tenantId string — Tenant Id - clientId string — Client Id - clientSecret string — Client Secret

Optional properties: - description string — Description: Instance Description - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "1486437a-8208-4ec8-bb50-cf7f394fcf51",
    "Config": "{\"name\": \"My Aveva Data Hub Integration\", \"description\": \"placeholder_description\", \"endpoint\": \"/example/path\", \"clientId\": \"my-client-id\", \"clientSecret\": \"password\", \"tenantId\": \"my-client-id\", \"stream\": \"placeholder_stream\", \"namespace\": \"placeholder_namespace\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "1486437a-8208-4ec8-bb50-cf7f394fcf51",
            "ProviderName": "Aveva Data Hub",
            "Config": "{\"name\": \"My Aveva Data Hub Integration\", \"description\": \"placeholder_description\", \"endpoint\": \"/example/path\", \"clientId\": \"my-client-id\", \"clientSecret\": \"password\", \"tenantId\": \"my-client-id\", \"stream\": \"placeholder_stream\", \"namespace\": \"placeholder_namespace\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - AWS IoT SiteWise (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 493124c6-c9c0-4583-a10f-c100fbfd9f42 Provider Name: AWS IoT SiteWise

Required properties: - secretAccessKey string — Secret access key: The secret access key - accessKey string — Access key: The access key - name string — Name: Instance Name - region string — Region: Region Name

Optional properties: - subscribeIntervalSeconds integer — Subscribe interval: The subscription polling interval in seconds - numberOfBatchMessagesToPublish integer — Number of batch messages: The number of batch messages to publish - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "493124c6-c9c0-4583-a10f-c100fbfd9f42",
    "Config": "{\"name\": \"My AWS IoT SiteWise Integration\", \"region\": \"us-west-2\", \"accessKey\": \"<certificate>\", \"secretAccessKey\": \"<certificate>\", \"subscribeIntervalSeconds\": 1, \"numberOfBatchMessagesToPublish\": 1, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "493124c6-c9c0-4583-a10f-c100fbfd9f42",
            "ProviderName": "AWS IoT SiteWise",
            "Config": "{\"name\": \"My AWS IoT SiteWise Integration\", \"region\": \"us-west-2\", \"accessKey\": \"<certificate>\", \"secretAccessKey\": \"<certificate>\", \"subscribeIntervalSeconds\": 1, \"numberOfBatchMessagesToPublish\": 1, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Azure Event Hubs (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: e37d3ef0-888c-480c-ad85-14e98c8162cb Provider Name: Azure Event Hubs

Required properties: - combineMessages boolean — Combine messages: Decrease count of messages by combine them to a single message - connectionString string — Connection string - connectionsCount integer — Parallel connections count: The count of parallel connections - name string — Name: Instance Name - maxMessageSize integer — Maximum message size: Maximum message size in KB

Optional properties: - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "e37d3ef0-888c-480c-ad85-14e98c8162cb",
    "Config": "{\"name\": \"My Azure Event Hubs Integration\", \"connectionString\": \"password\", \"maxMessageSize\": 256, \"connectionsCount\": 50, \"combineMessages\": true, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "e37d3ef0-888c-480c-ad85-14e98c8162cb",
            "ProviderName": "Azure Event Hubs",
            "Config": "{\"name\": \"My Azure Event Hubs Integration\", \"connectionString\": \"password\", \"maxMessageSize\": 256, \"connectionsCount\": 50, \"combineMessages\": true, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Azure Event Hubs

POST {{edgeUrl}}/cc/v2

Provider ID: ea6706b1-45b6-4401-aed9-b9a6192ee70d Provider Name: Azure Event Hubs Gen 2

Required properties: - endpoint string — Endpoint: Azure Service Bus endpoint URL - name string — Name: Instance Name - sharedAccessKey string — Shared Access Key: Shared Access Key value - sharedAccessKeyName string — Shared Access Key Name: Name of the Shared Access Policy - combineMessages boolean — Combine Messages: Combine multiple messages into a single JSON array to reduce message count - connectionsCount integer — Parallel Publish Count: The number of simultaneously publishing messages - entityPath string — Entity Path: Name of the Event Hub (entity path) - maxMessageSize integer — Maximum Message Size (KB): Maximum message size in KB

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - persistentStorage boolean — Persistent storage

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "ea6706b1-45b6-4401-aed9-b9a6192ee70d",
    "Config": "{\"name\": \"My Azure Event Hubs Gen 2 Integration\", \"endpoint\": \"sb://mynamespace.servicebus.windows.net/\", \"sharedAccessKeyName\": \"<certificate>\", \"sharedAccessKey\": \"<certificate>\", \"entityPath\": \"myeventhub\", \"maxMessageSize\": 256, \"connectionsCount\": 50, \"combineMessages\": true, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "ea6706b1-45b6-4401-aed9-b9a6192ee70d",
            "ProviderName": "Azure Event Hubs Gen 2",
            "Config": "{\"name\": \"My Azure Event Hubs Gen 2 Integration\", \"endpoint\": \"sb://mynamespace.servicebus.windows.net/\", \"sharedAccessKeyName\": \"<certificate>\", \"sharedAccessKey\": \"<certificate>\", \"entityPath\": \"myeventhub\", \"maxMessageSize\": 256, \"connectionsCount\": 50, \"combineMessages\": true, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Azure IoT Hub

POST {{edgeUrl}}/cc/v2

Provider ID: 916e0831-c570-496a-881f-660296747307 Provider Name: Azure IoT Hub using SAS Key over SSL Gen 2

Required properties: - tokenTTL integer — Token TTL (minutes): The token expiry time in minutes - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - name string — Name: Instance Name - deviceId string — Device ID: ID of the device as shown in your Azure IoT account. - sasKey string — SAS Key: Primary or secondary shared access key. - hostname string — Hostname: DNS name of MQTT host. It can be found in "Overview" tab of your Azure IoT hub.

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - willRetained boolean — LWT retained: MQTT LWT retained - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - port integer — Port: Port of MQTT host. - throttlingLimit integer — Throttling limit - willPayload string — LWT payload: MQTT LWT payload - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - willTopic string — LWT topic: MQTT LWT topic - topic string — Integration Topic: MQTT topic - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "916e0831-c570-496a-881f-660296747307",
    "Config": "{\"name\": \"My Azure IoT Hub using SAS Key over SSL Gen 2 Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"sasKey\": \"<certificate>\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"tokenTTL\": 1440, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "916e0831-c570-496a-881f-660296747307",
            "ProviderName": "Azure IoT Hub using SAS Key over SSL Gen 2",
            "Config": "{\"name\": \"My Azure IoT Hub using SAS Key over SSL Gen 2 Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"sasKey\": \"<certificate>\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"tokenTTL\": 1440, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Cognite Connector (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: aa838ac1-a31e-4166-b9c9-aeb7973bd122 Provider Name: Cognite Connector

Required properties: - name string — Name: Instance Name - projectID string — Project ID - scope string — Scope: Scope name - clientID string — Client ID - clientSecret string — Client Secret: Client secret - tenantID string — Tenant ID: Microsoft Azure Tenant ID - cluster string — Cluster: Cluster name

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - subscribeIntervalSeconds integer — Subscribe interval: The subscription polling interval in seconds - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "aa838ac1-a31e-4166-b9c9-aeb7973bd122",
    "Config": "{\"name\": \"My Cognite Connector Integration\", \"projectID\": \"my-client-id\", \"tenantID\": \"my-client-id\", \"clientID\": \"my-client-id\", \"clientSecret\": \"password\", \"cluster\": \"az-eastus-9\", \"scope\": \"https://az-eastus-9.cognitedata.com/.default\", \"subscribeIntervalSeconds\": 1, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "aa838ac1-a31e-4166-b9c9-aeb7973bd122",
            "ProviderName": "Cognite Connector",
            "Config": "{\"name\": \"My Cognite Connector Integration\", \"projectID\": \"my-client-id\", \"tenantID\": \"my-client-id\", \"clientID\": \"my-client-id\", \"clientSecret\": \"password\", \"cluster\": \"az-eastus-9\", \"scope\": \"https://az-eastus-9.cognitedata.com/.default\", \"subscribeIntervalSeconds\": 1, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Databricks Zerobus Ingest

POST {{edgeUrl}}/cc/v2

Provider ID: 0fb51adf-9e8c-49a7-80ac-1f232159a457 Provider Name: Databricks Zerobus Ingest

Required properties: - workspaceUrl string — Workspace URL: Databricks workspace URL - clientId string — Client ID: OAuth client ID to authenticate with Databricks - defaultTable string — Default Table: Default table name to publish data - recordType string — Record Type: Data record format: JSON Options: JSON - schema string — Schema: Databricks Schema name - zerobusServerUrl string — Zerobus Server URL: Databricks Zerobus Server URL. AWS format: .zerobus..cloud.databricks.com, Azure format: .zerobus..azuredatabricks.net - catalog string — Catalog: Databricks Catalog name - clientSecret string — Client Secret: OAuth client secret to authenticate with Databricks - name string — Name: User defined name of connector instance

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - persistentStorage boolean — Persistent storage - batchIngest integer — Batch Ingest: Set to 1 to use single ingest, >1 for batch ingest - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "0fb51adf-9e8c-49a7-80ac-1f232159a457",
    "Config": "{\"name\": \"__doc_0fb51adf_204343764039\", \"workspaceUrl\": \"https://abcd-teste2testspcse2.cloud.databricks.com\", \"zerobusServerUrl\": \"192.168.1.100\", \"catalog\": \"placeholder_catalog\", \"schema\": \"placeholder_schema\", \"clientId\": \"my-client-id\", \"clientSecret\": \"password\", \"defaultTable\": \"mytable\", \"createTable\": false, \"recordType\": \"JSON\", \"batchIngest\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"workersCount\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{"errors": [{"message": "zerobusServerUrl must follow format: <workspaceid>.zerobus.<region>.cloud.databricks.com (AWS) or <workspaceid>.zerobus.<region>.azuredatabricks.net (Azure)", "path": ["CreateInstance"]}], "data": null}

Create Instance - DB - Databricks SQL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 133c003c-2310-472d-95fe-991b74049311 Provider Name: DB - Databricks SQL

Required properties: - table string — Table: The table name - name string — Name: Instance Name - connString string — DSN Connection string: Data source name connection string - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions.

Optional properties: - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - commitTimeout integer — Commit timeout: Bulk insert commit timeout (ms) - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - mapping object — Mapping: The mapping list - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "133c003c-2310-472d-95fe-991b74049311",
    "Config": "{\"name\": \"My DB - Databricks SQL Integration\", \"connString\": \"password\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"bulkSize\": 0, \"commitTimeout\": 1000, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "133c003c-2310-472d-95fe-991b74049311",
            "ProviderName": "DB - Databricks SQL",
            "Config": "{\"name\": \"My DB - Databricks SQL Integration\", \"connString\": \"password\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"bulkSize\": 0, \"commitTimeout\": 1000, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - InfluxDB v1.7.x SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: f9fda829-c2e0-47a0-83bc-7a20f3ff897a Provider Name: DB - InfluxDB v1.7.x SSL

Required properties: - address string — InfluxDB address - database string — InfluxDB database name: Database name - name string — Name: Instance Name

Optional properties: - privateKey string — Private key: Private key can be added here. - batchSize integer — Insert batch size: The number of batch messages to insert - certificate string — Certificate: Certificate can be added here. - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - username string — Username - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - batchCommitTimeSec integer — Insert batch commit time: The time of batch messages to commit - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - password string — Password - persistentStorage boolean — Persistent storage

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "f9fda829-c2e0-47a0-83bc-7a20f3ff897a",
    "Config": "{\"name\": \"My DB - InfluxDB v1.7.x SSL Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "f9fda829-c2e0-47a0-83bc-7a20f3ff897a",
            "ProviderName": "DB - InfluxDB v1.7.x SSL",
            "Config": "{\"name\": \"My DB - InfluxDB v1.7.x SSL Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - InfluxDB v1.7.x TCP (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: a2ead4a5-d7de-41b4-a69b-76800fe6b978 Provider Name: DB - InfluxDB v1.7.x TCP

Required properties: - name string — Name: Instance Name - address string — InfluxDB address - database string — InfluxDB database name

Optional properties: - batchSize integer — Insert batch size: The number of batch messages to insert - password string — Password - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - username string — Username - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - batchCommitTimeSec integer — Insert batch commit time: The time of batch messages to commit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "a2ead4a5-d7de-41b4-a69b-76800fe6b978",
    "Config": "{\"name\": \"My DB - InfluxDB v1.7.x TCP Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"username\": \"admin\", \"password\": \"password\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "a2ead4a5-d7de-41b4-a69b-76800fe6b978",
            "ProviderName": "DB - InfluxDB v1.7.x TCP",
            "Config": "{\"name\": \"My DB - InfluxDB v1.7.x TCP Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"username\": \"admin\", \"password\": \"password\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - InfluxDB v2.x TCP (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: a2796f78-bab4-429a-9b18-47bcf104adb7 Provider Name: DB - InfluxDB v2.x TCP

Required properties: - name string — Name: Instance Name - address string — InfluxDB address - authToken string — Auth token - batchSize integer — Insert batch size: The number of batch messages to insert - organization string — Organization: Organization name - batchCommitTimeSec integer — Insert batch commit time: The time of batch messages to commit - database string — InfluxDB bucket name: Database name

Optional properties: - password string — Password - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - persistentStorage boolean — Persistent storage - username string — Username - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "a2796f78-bab4-429a-9b18-47bcf104adb7",
    "Config": "{\"name\": \"My DB - InfluxDB v2.x TCP Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"organization\": \"placeholder_organization\", \"authToken\": \"password\", \"username\": \"admin\", \"password\": \"password\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "a2796f78-bab4-429a-9b18-47bcf104adb7",
            "ProviderName": "DB - InfluxDB v2.x TCP",
            "Config": "{\"name\": \"My DB - InfluxDB v2.x TCP Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"organization\": \"placeholder_organization\", \"authToken\": \"password\", \"username\": \"admin\", \"password\": \"password\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - InfluxDB v2.x+ SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 7ee2ff5b-9f5f-4299-83f8-9b3617d79ace Provider Name: DB - InfluxDB v2.x+ SSL

Required properties: - address string — InfluxDB address - batchCommitTimeSec integer — Insert batch commit time: The time of batch messages to commit - database string — InfluxDB bucket name: Database name - batchSize integer — Insert batch size: The number of batch messages to insert - authToken string — Auth token - name string — Name: Instance Name - organization string — Organization: Organization name

Optional properties: - certificate string — Certificate: Certificate can be added here. - password string — Password - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - privateKey string — Private key: Private key can be added here. - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo - username string — Username

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "7ee2ff5b-9f5f-4299-83f8-9b3617d79ace",
    "Config": "{\"name\": \"My DB - InfluxDB v2.x+ SSL Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"organization\": \"placeholder_organization\", \"authToken\": \"password\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "7ee2ff5b-9f5f-4299-83f8-9b3617d79ace",
            "ProviderName": "DB - InfluxDB v2.x+ SSL",
            "Config": "{\"name\": \"My DB - InfluxDB v2.x+ SSL Integration\", \"address\": \"http://localhost:8086\", \"database\": \"mydb\", \"organization\": \"placeholder_organization\", \"authToken\": \"password\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"batchSize\": 500, \"batchCommitTimeSec\": 5, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - Microsoft SQL Server (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: b49b6e76-5c8f-4ca8-93b4-901edf3b2857 Provider Name: DB - Microsoft SQL Server

Required properties: - database string — Database: The database name - name string — Name: Instance Name - port integer — Port: Port of MSSQL host. - table string — Table: The table name - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - hostname string — Hostname: DNS name or IP of the host.

Optional properties: - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - mapping object — Mapping: The mapping list - password string — Password: The password - throttlingLimit integer — Throttling limit - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - username string — Username: The username - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - persistentStorage boolean — Persistent storage

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "b49b6e76-5c8f-4ca8-93b4-901edf3b2857",
    "Config": "{\"name\": \"My DB - Microsoft SQL Server Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1433, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "b49b6e76-5c8f-4ca8-93b4-901edf3b2857",
            "ProviderName": "DB - Microsoft SQL Server",
            "Config": "{\"name\": \"My DB - Microsoft SQL Server Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1433, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - Microsoft SQL Server SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 5121e79f-4e74-4048-b5f0-3a7f1242b148 Provider Name: DB - Microsoft SQL Server SSL

Required properties: - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - hostname string — Hostname: DNS name or IP of the host. - password string — Password: The password - database string — Database: The database name - port integer — Port: Port of MSSQL host. - table string — Table: The table name - username string — Username: The username - name string — Name: Instance Name - sslMode string — SSL Mode: SSL mode Options: disable, true, false

Optional properties: - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - mapping object — Mapping: The mapping list - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - queueMode string — Queue Mode Options: lifo, fifo - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - throttlingLimit integer — Throttling limit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "5121e79f-4e74-4048-b5f0-3a7f1242b148",
    "Config": "{\"name\": \"My DB - Microsoft SQL Server SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1433, \"sslMode\": \"true\", \"caCert\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "5121e79f-4e74-4048-b5f0-3a7f1242b148",
            "ProviderName": "DB - Microsoft SQL Server SSL",
            "Config": "{\"name\": \"My DB - Microsoft SQL Server SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1433, \"sslMode\": \"true\", \"caCert\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - MongoDB (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: abc92242-1591-49b2-a747-439c72ecf68d Provider Name: DB - MongoDB

Required properties: - collection string — Collection: The collection - database string — Database: The database name - hostname string — Hostname: DNS name or IP of the host. - name string — Name: Instance Name - port integer — Port: Port of MongoDB host.

Optional properties: - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - mapping object — Mapping: The mapping list - persistentStorage boolean — Persistent storage - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - authMechanism string — Auth mechanism: The mechanisms to confirm an identity and establish trust to ensure security in the driver and server before connecting Options: SCRAM-SHA-1, MONGODB-CR, MONGO-CR, PLAIN, MONGODB-X509 - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - password string — Password: The password - username string — Username: The username - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - authDatabase string — Auth database: The authentication database name

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "abc92242-1591-49b2-a747-439c72ecf68d",
    "Config": "{\"name\": \"My DB - MongoDB Integration\", \"hostname\": \"192.168.1.100\", \"port\": 27017, \"username\": \"admin\", \"password\": \"password\", \"authDatabase\": \"mydb\", \"authMechanism\": \"SCRAM-SHA-1\", \"database\": \"mydb\", \"collection\": \"mytable\", \"mapping\": {}, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "abc92242-1591-49b2-a747-439c72ecf68d",
            "ProviderName": "DB - MongoDB",
            "Config": "{\"name\": \"My DB - MongoDB Integration\", \"hostname\": \"192.168.1.100\", \"port\": 27017, \"username\": \"admin\", \"password\": \"password\", \"authDatabase\": \"mydb\", \"authMechanism\": \"SCRAM-SHA-1\", \"database\": \"mydb\", \"collection\": \"mytable\", \"mapping\": {}, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - MongoDB v4+ (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 363c6939-b6dc-409b-a6d6-b553692bcf2a Provider Name: DB - MongoDB v4+

Required properties: - hostname string — Hostname: DNS name or IP of the host. - name string — Name: Instance Name - port integer — Port: Port of MongoDB host. - collection string — Collection: The collection - database string — Database: The database name

Optional properties: - authDatabase string — Auth database: The authentication database name - authMechanism string — Auth mechanism: The mechanisms to confirm an identity and establish trust to ensure security in the driver and server before connecting Options: SCRAM-SHA-1, MONGODB-CR, MONGO-CR, PLAIN, MONGODB-X509 - queueMode string — Queue Mode Options: lifo, fifo - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - mapping object — Mapping: The mapping list - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - persistentStorage boolean — Persistent storage - throttlingLimit integer — Throttling limit - password string — Password: The password - username string — Username: The username

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "363c6939-b6dc-409b-a6d6-b553692bcf2a",
    "Config": "{\"name\": \"My DB - MongoDB v4+ Integration\", \"hostname\": \"192.168.1.100\", \"port\": 27017, \"username\": \"admin\", \"password\": \"password\", \"authDatabase\": \"mydb\", \"authMechanism\": \"SCRAM-SHA-1\", \"database\": \"mydb\", \"collection\": \"mytable\", \"mapping\": {}, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "363c6939-b6dc-409b-a6d6-b553692bcf2a",
            "ProviderName": "DB - MongoDB v4+",
            "Config": "{\"name\": \"My DB - MongoDB v4+ Integration\", \"hostname\": \"192.168.1.100\", \"port\": 27017, \"username\": \"admin\", \"password\": \"password\", \"authDatabase\": \"mydb\", \"authMechanism\": \"SCRAM-SHA-1\", \"database\": \"mydb\", \"collection\": \"mytable\", \"mapping\": {}, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - MySQL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 2dff6cc6-c383-4744-a78b-e2892ae05c49 Provider Name: DB - MySQL

Required properties: - username string — Username: The username - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - table string — Table: The table name - database string — Database: The database name - name string — Name: Instance Name - port integer — Port: Port of MySql host. - hostname string — Hostname: DNS name or IP of the host.

Optional properties: - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - password string — Password: The password - throttlingLimit integer — Throttling limit - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - mapping object — Mapping: The mapping list - persistentStorage boolean — Persistent storage - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "2dff6cc6-c383-4744-a78b-e2892ae05c49",
    "Config": "{\"name\": \"My DB - MySQL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 3306, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "2dff6cc6-c383-4744-a78b-e2892ae05c49",
            "ProviderName": "DB - MySQL",
            "Config": "{\"name\": \"My DB - MySQL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 3306, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - MySQL SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: e4aa0200-3dae-4292-b7bf-499e293c7b33 Provider Name: DB - MySQL SSL

Required properties: - database string — Database: The database name - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - hostname string — Hostname: DNS name or IP of the host. - username string — Username: The username - name string — Name: Instance Name - port integer — Port: Port of MySql host. - table string — Table: The table name

Optional properties: - password string — Password: The password - persistentStorage boolean — Persistent storage - privateKey string — Private key: Private key can be added here. - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - mapping object — Mapping: The mapping list - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - certificate string — Certificate: Certificate can be added here. - queueMode string — Queue Mode Options: lifo, fifo - sslMode string — SSL Mode: SSL mode Options: require - throttlingLimit integer — Throttling limit - commitTimeout integer — Commit timeout: Transaction commit timeout (ms)

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "e4aa0200-3dae-4292-b7bf-499e293c7b33",
    "Config": "{\"name\": \"My DB - MySQL SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 3306, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"sslMode\": \"require\"}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "e4aa0200-3dae-4292-b7bf-499e293c7b33",
            "ProviderName": "DB - MySQL SSL",
            "Config": "{\"name\": \"My DB - MySQL SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 3306, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"sslMode\": \"require\"}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - PostgreSQL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 13e1ec1f-4774-4515-8af9-26fccd4590a8 Provider Name: DB - PostgreSQL

Required properties: - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - hostname string — Hostname: DNS name or IP of the host. - name string — Name: Instance Name - password string — Password: The password - table string — Table: The table name - database string — Database: The database name - username string — Username: The username - port integer — Port: Port of PostgreSQL host.

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - mapping object — Mapping: The mapping list - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - persistentStorage boolean — Persistent storage - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "13e1ec1f-4774-4515-8af9-26fccd4590a8",
    "Config": "{\"name\": \"My DB - PostgreSQL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5432, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "13e1ec1f-4774-4515-8af9-26fccd4590a8",
            "ProviderName": "DB - PostgreSQL",
            "Config": "{\"name\": \"My DB - PostgreSQL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5432, \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - PostgreSQL SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: b3c894c3-f11b-4d06-b720-68a52d1f6835 Provider Name: DB - PostgreSQL SSL

Required properties: - table string — Table: The table name - port integer — Port: Port of PostgreSQL host. - sslMode string — SSL Mode: SSL mode Options: require, verify-ca, verify-full - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions. - database string — Database: The database name - hostname string — Hostname: DNS name or IP of the host. - name string — Name: Instance Name

Optional properties: - password string — Password: The password - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - certificate string — Certificate: Certificate can be added here. - mapping object — Mapping: The mapping list - username string — Username: The username - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - privateKey string — Private key: Private key can be added here. - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "b3c894c3-f11b-4d06-b720-68a52d1f6835",
    "Config": "{\"name\": \"My DB - PostgreSQL SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5432, \"sslMode\": \"require\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "b3c894c3-f11b-4d06-b720-68a52d1f6835",
            "ProviderName": "DB - PostgreSQL SSL",
            "Config": "{\"name\": \"My DB - PostgreSQL SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 5432, \"sslMode\": \"require\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"table\": \"mytable\", \"mapping\": {}, \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - DB - Snowflake (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: a870453f-e1bc-4c04-ba9f-b8f8224646a9 Provider Name: DB - Snowflake

Required properties: - database string — Database: The database name - name string — Name: Instance Name - schema string — Schema: The schema name - password string — Password: The password - warehouse string — Warehouse: The warehouse name - table string — Table: The table name - username string — Username: The username - accountName string — Account: Account Name - createTable boolean — Create table: Create the table if it doesn't exist. To do this you need permissions.

Optional properties: - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - bulkSize integer — Bulk insert count: Buffer messages and perform bulk insert once the Bulk insert count is reached - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - commitTimeout integer — Commit timeout: Transaction commit timeout (ms) - maxTransactionSize integer — Max transaction size: Maximum number of messages before a transaction is committed regardless of timeout - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "a870453f-e1bc-4c04-ba9f-b8f8224646a9",
    "Config": "{\"name\": \"My DB - Snowflake Integration\", \"accountName\": \"placeholder_accountName\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"schema\": \"placeholder_schema\", \"warehouse\": \"placeholder_warehouse\", \"table\": \"mytable\", \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "a870453f-e1bc-4c04-ba9f-b8f8224646a9",
            "ProviderName": "DB - Snowflake",
            "Config": "{\"name\": \"My DB - Snowflake Integration\", \"accountName\": \"placeholder_accountName\", \"username\": \"admin\", \"password\": \"password\", \"database\": \"mydb\", \"schema\": \"placeholder_schema\", \"warehouse\": \"placeholder_warehouse\", \"table\": \"mytable\", \"createTable\": false, \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"bulkSize\": 0, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Google Cloud Pub/Sub Connector (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 962fa4a8-3c82-4e3a-af50-9603b179d435 Provider Name: Google Cloud Pub/Sub Connector

Required properties: - projectId string — Project ID: The project ID of the cloud project - topic string — Integration Topic: Sub topic - key string — Credentials (.json) - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details.

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - publishByteThreshold integer — Publish byte threshold: Publish byte threshold (0 is a default value, could be interpreted like - no limits) - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - publishDelayThreshold integer — Publish delay threshold (Milliseconds): Publish delay threshold (0 is a default value, could be interpreted like - no limits) - clientEmail string — Client Email: The client email of the cloud project - meta object — Custom Attributes: The custom attributes - privateKeyID string — Private Key ID: The private key ID of the cloud project - publishCountThreshold integer — Publish count threshold: Publish count threshold (0 is a default value, could be interpreted like - no limits) - persistentStorage boolean — Persistent storage

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "962fa4a8-3c82-4e3a-af50-9603b179d435",
    "Config": "{\"name\": \"My Google Cloud Pub/Sub Connector Integration\", \"key\": \"<certificate>\", \"projectId\": \"my-client-id\", \"privateKeyID\": \"password\", \"clientEmail\": \"placeholder_clientEmail\", \"topic\": \"projects/project-identifier/collection/relative-name\", \"meta\": {}, \"workersCount\": 100, \"publishByteThreshold\": 0, \"publishCountThreshold\": 0, \"publishDelayThreshold\": 0, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "962fa4a8-3c82-4e3a-af50-9603b179d435",
            "ProviderName": "Google Cloud Pub/Sub Connector",
            "Config": "{\"name\": \"My Google Cloud Pub/Sub Connector Integration\", \"key\": \"<certificate>\", \"projectId\": \"my-client-id\", \"privateKeyID\": \"password\", \"clientEmail\": \"placeholder_clientEmail\", \"topic\": \"projects/project-identifier/collection/relative-name\", \"meta\": {}, \"workersCount\": 100, \"publishByteThreshold\": 0, \"publishCountThreshold\": 0, \"publishDelayThreshold\": 0, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - InfluxDB v3

POST {{edgeUrl}}/cc/v2

Provider ID: a55ebcc8-3ec9-4a10-8f2b-ff615d480e36 Provider Name: InfluxDB v3

Required properties: - token string — API Token: Authentication token with appropriate scoped permissions - connectionType string — Connection Type: Select TCP for plain connection or SSL for TLS- encrypted connection Options: tcp, ssl - name string — Name: Instance Name - host string — Host URL: InfluxDB v3 server URL - database string — Database: Target InfluxDB v3 database name (formally Bucket in v2)

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - batchIntervalMs integer — Batch Interval (ms): Time interval between write flushes in milliseconds - batchSize integer — Batch Size: Number of records per write batch - organization string — Organization: Organization name or ID. Required for InfluxDB Cloud services. - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - certificate string — Certificate: Certificate can be added here. - persistentStorage boolean — Persistent storage - staticTags object — Static Tags: Static key-value pairs appended as tags to all data published to InfluxDB - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - precision string — Write Precision: Timestamp precision for publishing data (ns=nanoseconds, us=microseconds, ms=milliseconds, s=seconds) Options: ns, us, ms, s - privateKey string — Private Key: Private key can be added here.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "a55ebcc8-3ec9-4a10-8f2b-ff615d480e36",
    "Config": "{\"name\": \"My InfluxDB v3 Integration\", \"host\": \"https://us-east-1-1.aws.cloud2.influxdata.com\", \"connectionType\": \"tcp\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"organization\": \"my-org\", \"database\": \"mydb\", \"token\": \"password\", \"staticTags\": {}, \"precision\": \"ms\", \"batchSize\": 5000, \"batchIntervalMs\": 1000, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "a55ebcc8-3ec9-4a10-8f2b-ff615d480e36",
            "ProviderName": "InfluxDB v3",
            "Config": "{\"name\": \"My InfluxDB v3 Integration\", \"host\": \"https://us-east-1-1.aws.cloud2.influxdata.com\", \"connectionType\": \"tcp\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"organization\": \"my-org\", \"database\": \"mydb\", \"token\": \"password\", \"staticTags\": {}, \"precision\": \"ms\", \"batchSize\": 5000, \"batchIntervalMs\": 1000, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Kafka SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: d2413da3-fd32-48dd-ab66-6e62090a5f6d Provider Name: Kafka SSL

Required properties: - brokers string — Brokers list separated by comma - topic string — Topic: The topic name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - insecureSkipVerify boolean — Insecure Skip Verify: Insecure Skip Verify controls whether a client verifies the server's certificate chain and host name - saslMechanism string — SASL mechanism Options: NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 - name string — Name: Instance Name

Optional properties: - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - certificate string — Certificate: Certificate can be added here. - throttlingLimit integer — Throttling limit - password string — Password: The password - privateKey string — Private key: Private key can be added here. - username string — Username: The username - persistentStorage boolean — Persistent storage

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "d2413da3-fd32-48dd-ab66-6e62090a5f6d",
    "Config": "{\"name\": \"My Kafka SSL Integration\", \"brokers\": \"one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094\", \"saslMechanism\": \"SCRAM-SHA-256\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"insecureSkipVerify\": false, \"topic\": \"integration/data\", \"workersCount\": 2000, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "d2413da3-fd32-48dd-ab66-6e62090a5f6d",
            "ProviderName": "Kafka SSL",
            "Config": "{\"name\": \"My Kafka SSL Integration\", \"brokers\": \"one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094\", \"saslMechanism\": \"SCRAM-SHA-256\", \"username\": \"admin\", \"password\": \"password\", \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"insecureSkipVerify\": false, \"topic\": \"integration/data\", \"workersCount\": 2000, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Kafka TCP (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 8e2f6527-519b-484c-ae51-226d67036e86 Provider Name: Kafka TCP

Required properties: - saslMechanism string — SASL mechanism Options: NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 - topic string — Topic: The topic name - brokers string — Brokers list separated by comma - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - username string — Username: The username - password string — Password: The password - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "8e2f6527-519b-484c-ae51-226d67036e86",
    "Config": "{\"name\": \"My Kafka TCP Integration\", \"brokers\": \"one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094\", \"saslMechanism\": \"SCRAM-SHA-256\", \"username\": \"admin\", \"password\": \"password\", \"topic\": \"integration/data\", \"workersCount\": 2000, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "8e2f6527-519b-484c-ae51-226d67036e86",
            "ProviderName": "Kafka TCP",
            "Config": "{\"name\": \"My Kafka TCP Integration\", \"brokers\": \"one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094\", \"saslMechanism\": \"SCRAM-SHA-256\", \"username\": \"admin\", \"password\": \"password\", \"topic\": \"integration/data\", \"workersCount\": 2000, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Litmus UNS (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 2a7e325f-0dc5-4069-be4b-a6ba88d6f8a4 Provider Name: Litmus UNS

Required properties: - name string — Name: Instance Name

Optional properties: - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - UNSHierarchy string — UNS Hierarchy: UNS Hierarchy levels info - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - token string — Litmus UNS Token: Base64 one-time Token to access Litmus UNS endpoint - UNSClientID string — MQTT Client ID: Litmus UNS MQTT Client ID - insecureSkipVerify boolean — Insecure skip verify

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "2a7e325f-0dc5-4069-be4b-a6ba88d6f8a4",
    "Config": "{\"name\": \"My Litmus UNS Integration\", \"workersCount\": 100, \"UNSClientID\": \"my-client-id\", \"insecureSkipVerify\": false, \"caCert\": \"\", \"UNSHierarchy\": \"\", \"token\": \"password\", \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"jsonConfig\": \"\", \"throttlingLimit\": 0}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "2a7e325f-0dc5-4069-be4b-a6ba88d6f8a4",
            "ProviderName": "Litmus UNS",
            "Config": "{\"name\": \"My Litmus UNS Integration\", \"workersCount\": 100, \"UNSClientID\": \"my-client-id\", \"insecureSkipVerify\": false, \"caCert\": \"\", \"UNSHierarchy\": \"\", \"token\": \"password\", \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"jsonConfig\": \"\", \"throttlingLimit\": 0}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - AWS IoT Core over SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: f0df18e2-9ef9-480a-87e8-0510ef27d21d Provider Name: MQTT - Amazon AWS IoT Core over SSL

Required properties: - hostname string — Hostname: DNS name of MQTT host. - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - topic string — Integration Topic: MQTT topic - certificate string — Certificate: Certificate can be added here. - privateKey string — Private key: Private key can be added here.

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - willPayload string — LWT payload: MQTT LWT payload - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - queueMode string — Queue Mode Options: lifo, fifo - willRetained boolean — LWT retained: MQTT LWT retained - port integer — Port: Port of MQTT host. - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - persistentStorage boolean — Persistent storage - throttlingLimit integer — Throttling limit - willTopic string — LWT topic: MQTT LWT topic - clientId string — Client ID: Client ID is required by MQTT server.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "f0df18e2-9ef9-480a-87e8-0510ef27d21d",
    "Config": "{\"name\": \"My MQTT - Amazon AWS IoT Core over SSL Integration\", \"hostname\": \"a1o8e9c82gegra.iot.us-east-2.amazonaws.com\", \"port\": 8883, \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"my-client-id\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"/events\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "f0df18e2-9ef9-480a-87e8-0510ef27d21d",
            "ProviderName": "MQTT - Amazon AWS IoT Core over SSL",
            "Config": "{\"name\": \"My MQTT - Amazon AWS IoT Core over SSL Integration\", \"hostname\": \"a1o8e9c82gegra.iot.us-east-2.amazonaws.com\", \"port\": 8883, \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"my-client-id\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"/events\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - AWS IoT Core

POST {{edgeUrl}}/cc/v2

Provider ID: 8a7829cb-95cc-4ab8-9ed3-94fa99a8e4db Provider Name: MQTT - AWS IoT Core Gen 2

Required properties: - name string — Name: Instance Name - privateKey string — Private key: Private key can be added here. - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - certificate string — Certificate: Certificate can be added here. - hostname string — Hostname: DNS name of MQTT host. - topic string — Integration Topic: MQTT topic

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - willPayload string — LWT payload: MQTT LWT payload - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - port integer — Port: Port of MQTT host. - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - willRetained boolean — LWT retained: MQTT LWT retained - willTopic string — LWT topic: MQTT LWT topic - caCert string — CA Certificate: Amazon Root CA certificate (optional - uses system trust store if not provided). - clientId string — Client ID: Client ID is required by MQTT server.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "8a7829cb-95cc-4ab8-9ed3-94fa99a8e4db",
    "Config": "{\"name\": \"__doc_8a7829cb_204316120153\", \"hostname\": \"a1o8e9c82gegra.iot.us-east-2.amazonaws.com\", \"port\": 8883, \"certificate\": \"\", \"privateKey\": \"\", \"caCert\": \"\", \"clientId\": \"my-client-id\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"/events\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{"errors": [{"message": "invalid config: certificate is required for AWS IoT Core", "path": ["CreateInstance"]}], "data": null}

Create Instance - MQTT - AWS IoT SiteWise Edge (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 69d06521-c16f-4f38-a9e9-4cd0f0edbfe7 Provider Name: MQTT - AWS IoT SiteWise Edge

Required properties: - clientId string — Client ID: Client ID is required by MQTT server. - port integer — Port: Port of MQTT host. - hostname string — Hostname: DNS name of MQTT host. - topic string — Integration Topic: MQTT topic - name string — Instance Name - propertyAlias string — Property Alias: AWS IoT Sitewise Asset Property Alias

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - additionalAliasDefinition string — Additional Alias Definition: Optional string to further define dynamic propertyAlias and Integration Topic - throttlingLimit integer — Throttling limit - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - willPayload string — LWT payload: MQTT LWT payload - willTopic string — LWT topic: MQTT LWT topic - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "69d06521-c16f-4f38-a9e9-4cd0f0edbfe7",
    "Config": "{\"name\": \"My MQTT - AWS IoT SiteWise Edge Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"propertyAlias\": \"placeholder_propertyAlias\", \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"additionalAliasDefinition\": \"placeholder_additionalAliasDefinition\", \"qos\": 1, \"workersCount\": 100, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "69d06521-c16f-4f38-a9e9-4cd0f0edbfe7",
            "ProviderName": "MQTT - AWS IoT SiteWise Edge",
            "Config": "{\"name\": \"My MQTT - AWS IoT SiteWise Edge Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"propertyAlias\": \"placeholder_propertyAlias\", \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"additionalAliasDefinition\": \"placeholder_additionalAliasDefinition\", \"qos\": 1, \"workersCount\": 100, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - AWS IoT SiteWise Edge

POST {{edgeUrl}}/cc/v2

Provider ID: 3de888ec-a6cf-4de8-9ed7-b87b70b98e7c Provider Name: MQTT - AWS IoT SiteWise Edge Gen 2

Required properties: - port integer — Port: Port of MQTT host. - topic string — Integration Topic: MQTT topic - name string — Instance Name - clientId string — Client ID: Client ID is required by MQTT server. - hostname string — Hostname: DNS name of MQTT host. - propertyAlias string — Property Alias: AWS IoT Sitewise Asset Property Alias

Optional properties: - additionalAliasDefinition string — Additional Alias Definition: Optional string to further define dynamic propertyAlias and Integration Topic - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - willTopic string — LWT topic: MQTT LWT topic - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - willPayload string — LWT payload: MQTT LWT payload - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - queueMode string — Queue Mode Options: lifo, fifo - persistentStorage boolean — Persistent storage - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "3de888ec-a6cf-4de8-9ed7-b87b70b98e7c",
    "Config": "{\"name\": \"My MQTT - AWS IoT SiteWise Edge Gen 2 Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"propertyAlias\": \"placeholder_propertyAlias\", \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"additionalAliasDefinition\": \"placeholder_additionalAliasDefinition\", \"qos\": 1, \"workersCount\": 100, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "3de888ec-a6cf-4de8-9ed7-b87b70b98e7c",
            "ProviderName": "MQTT - AWS IoT SiteWise Edge Gen 2",
            "Config": "{\"name\": \"My MQTT - AWS IoT SiteWise Edge Gen 2 Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"propertyAlias\": \"placeholder_propertyAlias\", \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"additionalAliasDefinition\": \"placeholder_additionalAliasDefinition\", \"qos\": 1, \"workersCount\": 100, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - Azure IoT Hub using Device Certificates (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 395bf3a8-17f9-4ebf-8bd9-23d1b88d887e Provider Name: MQTT - Azure IoT Hub using Device Certificates

Required properties: - hostname string — Hostname: DNS name of MQTT host. It can be found in "Overview" tab of your Azure IoT hub. - privateKey string — Private key: Device key - deviceId string — Device ID: ID of the device as shown in your Azure IoT hub. - certificate string — Certificate: Device certificate - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details.

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - port integer — Port: Port of MQTT host. - throttlingLimit integer — Throttling limit - willPayload string — LWT payload: MQTT LWT payload - persistentStorage boolean — Persistent storage - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - willRetained boolean — LWT retained: MQTT LWT retained - queueMode string — Queue Mode Options: lifo, fifo - topic string — Integration Topic: MQTT topic - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willTopic string — LWT topic: MQTT LWT topic

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "395bf3a8-17f9-4ebf-8bd9-23d1b88d887e",
    "Config": "{\"name\": \"My MQTT - Azure IoT Hub using Device Certificates Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"certificate\": \"\", \"privateKey\": \"\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "395bf3a8-17f9-4ebf-8bd9-23d1b88d887e",
            "ProviderName": "MQTT - Azure IoT Hub using Device Certificates",
            "Config": "{\"name\": \"My MQTT - Azure IoT Hub using Device Certificates Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"certificate\": \"\", \"privateKey\": \"\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - Azure IoT Hub using SAS Key (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 02fcf6e4-fcdf-490e-b578-1e8b4cf03684 Provider Name: MQTT - Azure IoT Hub using SAS Key

Required properties: - tokenTTL integer — Token TTL (minutes): The token expiry time in minutes - name string — Name: Instance Name - hostname string — Hostname: DNS name of MQTT host. It can be found in "Overview" tab of your Azure IoT hub. - sasKey string — SAS Key: Primary or secondary shared access key. - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - deviceId string — Device ID: ID of the device as shown in your Azure IoT account.

Optional properties: - willRetained boolean — LWT retained: MQTT LWT retained - topic string — Integration Topic: MQTT topic - willPayload string — LWT payload: MQTT LWT payload - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - persistentStorage boolean — Persistent storage - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - port integer — Port: Port of MQTT host. - willTopic string — LWT topic: MQTT LWT topic - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "02fcf6e4-fcdf-490e-b578-1e8b4cf03684",
    "Config": "{\"name\": \"My MQTT - Azure IoT Hub using SAS Key Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"sasKey\": \"<certificate>\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"tokenTTL\": 1440, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "02fcf6e4-fcdf-490e-b578-1e8b4cf03684",
            "ProviderName": "MQTT - Azure IoT Hub using SAS Key",
            "Config": "{\"name\": \"My MQTT - Azure IoT Hub using SAS Key Integration\", \"hostname\": \"loopedge.azure-devices.net\", \"port\": 8883, \"deviceId\": \"loopedge-000c29dedd9e\", \"sasKey\": \"<certificate>\", \"workersCount\": 16, \"topic\": \"devices/loopedge-000c29dedd9e/messages/events/\", \"tokenTTL\": 1440, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - Generic (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 91d5953e-91bd-4564-acf8-05d662ddb090 Provider Name: MQTT - Generic

Required properties: - hostname string — Hostname: DNS name of MQTT host. - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details.

Optional properties: - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - willTopic string — LWT topic: MQTT LWT topic - persistentStorage boolean — Persistent storage - port integer — Port: Port of MQTT host. - topic string — Integration Topic: MQTT topic - username string — Username: The username - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - clientId string — Client ID: Client ID is required by MQTT server. - password string — Password: The password - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - throttlingLimit integer — Throttling limit - willPayload string — LWT payload: MQTT LWT payload - willRetained boolean — LWT retained: MQTT LWT retained - queueMode string — Queue Mode Options: lifo, fifo - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "91d5953e-91bd-4564-acf8-05d662ddb090",
    "Config": "{\"name\": \"My MQTT - Generic Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "91d5953e-91bd-4564-acf8-05d662ddb090",
            "ProviderName": "MQTT - Generic",
            "Config": "{\"name\": \"My MQTT - Generic Integration\", \"hostname\": \"192.168.1.100\", \"port\": 1883, \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - Generic

POST {{edgeUrl}}/cc/v2

Provider ID: 0e04a6f5-dc0c-4bd8-84b9-dc2b1b74b110 Provider Name: MQTT - Generic Gen 2

Required properties: - topic string — Integration Topic: MQTT topic - connectionType string — Connection Type: MQTT Connection type Options: tcp, ssl - hostname string — Hostname: DNS name of MQTT host. - name string — Name: Instance Name - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details.

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - certificate string — Certificate: Certificate can be added here. - password string — Password: The password - persistentStorage boolean — Persistent storage - port integer — Port: Port of MQTT host. - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willTopic string — LWT topic: MQTT LWT topic - clientId string — Client ID: Client ID is required by MQTT server. - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - privateKey string — Private key: Private key can be added here. - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - throttlingLimit integer — Throttling limit - username string — Username: The username - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - pingTimeout integer — Ping Timeout (seconds): The time a client waits for a ping response from the broker after sending a PINGREQ message - willPayload string — LWT payload: MQTT LWT payload - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - willRetained boolean — LWT retained: MQTT LWT retained

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "0e04a6f5-dc0c-4bd8-84b9-dc2b1b74b110",
    "Config": "{\"name\": \"My MQTT - Generic Gen 2 Integration\", \"connectionType\": \"tcp\", \"hostname\": \"192.168.1.100\", \"port\": 1883, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"pingTimeout\": 7, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "0e04a6f5-dc0c-4bd8-84b9-dc2b1b74b110",
            "ProviderName": "MQTT - Generic Gen 2",
            "Config": "{\"name\": \"My MQTT - Generic Gen 2 Integration\", \"connectionType\": \"tcp\", \"hostname\": \"192.168.1.100\", \"port\": 1883, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"pingTimeout\": 7, \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - Generic over SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 53efdc1f-4e02-413f-b28d-b69334041718 Provider Name: MQTT - Generic over SSL

Required properties: - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - hostname string — Hostname: DNS name of MQTT host. - name string — Name: Instance Name

Optional properties: - throttlingLimit integer — Throttling limit - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - certificate string — Certificate: Certificate can be added here. - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - password string — Password: The password - port integer — Port: Port of MQTT host. - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - queueMode string — Queue Mode Options: lifo, fifo - topic string — Integration Topic: MQTT topic - username string — Username: The username - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - privateKey string — Private key: Private key can be added here. - willPayload string — LWT payload: MQTT LWT payload - willRetained boolean — LWT retained: MQTT LWT retained - clientId string — Client ID: Client ID is required by MQTT server. - willTopic string — LWT topic: MQTT LWT topic

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "53efdc1f-4e02-413f-b28d-b69334041718",
    "Config": "{\"name\": \"My MQTT - Generic over SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "53efdc1f-4e02-413f-b28d-b69334041718",
            "ProviderName": "MQTT - Generic over SSL",
            "Config": "{\"name\": \"My MQTT - Generic over SSL Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8883, \"caCert\": \"\", \"certificate\": \"\", \"privateKey\": \"\", \"clientId\": \"5dlvtw2sbbn4hqltaecpit115\", \"username\": \"admin\", \"password\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - MQTT - IBM Watson over SSL (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 3f87d2be-a30e-4304-b618-b9f1b48d21a3 Provider Name: MQTT - IBM Watson over SSL

Required properties: - deviceType string — Device Type: Device Type is required by MQTT server. - orgId string — Organization ID: The unique six-character organization ID - token string — Token: Token that was generated when the device was registered with Watson IoT Platform. - topic string — Integration Topic: MQTT topic - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - deviceId string — Device ID: Device ID is required by MQTT server. - hostname string — Hostname: DNS name of MQTT host. - name string — Name: Instance Name - port integer — Port: Port of MQTT host.

Optional properties: - qos integer — QoS: MQTT QoS attribute. Options: 0, 1, 2 - queueMode string — Queue Mode Options: lifo, fifo - willPayload string — LWT payload: MQTT LWT payload - willPayloadType string — LWT payload type: MQTT LWT payload type Options: string, base64 - willRetained boolean — LWT retained: MQTT LWT retained - throttlingLimit integer — Throttling limit - willQoS integer — LWT QoS: MQTT LWT QoS attribute. Options: 0, 1, 2 - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - willTopic string — LWT topic: MQTT LWT topic

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "3f87d2be-a30e-4304-b618-b9f1b48d21a3",
    "Config": "{\"name\": \"My MQTT - IBM Watson over SSL Integration\", \"hostname\": \"{orgId}.messaging.internetofthings.ibmcloud.com\", \"port\": 8883, \"caCert\": \"\", \"orgId\": \"my-client-id\", \"deviceType\": \"DeviceType1\", \"deviceId\": \"Device1\", \"token\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"iot-2/evt/status/fmt/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "3f87d2be-a30e-4304-b618-b9f1b48d21a3",
            "ProviderName": "MQTT - IBM Watson over SSL",
            "Config": "{\"name\": \"My MQTT - IBM Watson over SSL Integration\", \"hostname\": \"{orgId}.messaging.internetofthings.ibmcloud.com\", \"port\": 8883, \"caCert\": \"\", \"orgId\": \"my-client-id\", \"deviceType\": \"DeviceType1\", \"deviceId\": \"Device1\", \"token\": \"password\", \"qos\": 1, \"workersCount\": 100, \"topic\": \"iot-2/evt/status/fmt/json\", \"willTopic\": \"integration/data\", \"willPayload\": \"placeholder_willPayload\", \"willPayloadType\": \"string\", \"willQoS\": 1, \"willRetained\": false, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - NATS (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 286b6ec7-4069-4022-81c4-6e4826a9662c Provider Name: NATS

Required properties: - hostname string — Hostname - topic string — Default topic name - name string — Name: Instance Name - port integer — Port: Port of NATS host. - enableTLS boolean — Enable TLS secure connection

Optional properties: - queueMode string — Queue Mode Options: lifo, fifo - throttlingLimit integer — Throttling limit - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - insecureSkipVerify boolean — Insecure skip verify: InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. - password string — NATS Password: Password - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - username string — NATS Username: Username

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "286b6ec7-4069-4022-81c4-6e4826a9662c",
    "Config": "{\"name\": \"My NATS Integration\", \"hostname\": \"192.168.1.100\", \"port\": 4222, \"username\": \"admin\", \"password\": \"password\", \"topic\": \"integration/data\", \"enableTLS\": false, \"insecureSkipVerify\": false, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "286b6ec7-4069-4022-81c4-6e4826a9662c",
            "ProviderName": "NATS",
            "Config": "{\"name\": \"My NATS Integration\", \"hostname\": \"192.168.1.100\", \"port\": 4222, \"username\": \"admin\", \"password\": \"password\", \"topic\": \"integration/data\", \"enableTLS\": false, \"insecureSkipVerify\": false, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - NATS

POST {{edgeUrl}}/cc/v2

Provider ID: b281db24-2092-4e8d-b735-f774bde9bd62 Provider Name: NATS Gen 2

Required properties: - enableTLS boolean — Enable TLS secure connection - port integer — Port: Port of NATS host. - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - name string — Name: Instance Name - topic string — Default topic name - hostname string — Hostname

Optional properties: - username string — NATS Username: Username - insecureSkipVerify boolean — Insecure skip verify: InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. - password string — NATS Password: Password - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - connectTimeoutSeconds integer — Connect timeout (second): Timeout sets the timeout for a Dial operation on a connection - flushTimeoutSeconds integer — Flush timeout (second): Timeout for flushing buffered messages to the server during publish operations - maxReconnect integer — Max Reconnect: MaxReconnect sets the number of reconnect attempts that will be tried before giving up. If negative, then it will never give up trying to reconnect, If zero, then will use default value (5) - queueMode string — Queue Mode Options: lifo, fifo - reconnectWait integer — Reconnect wait (second): ReconnectWait sets the time to backoff after attempting a reconnect to a server that we were already connected to previously

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "b281db24-2092-4e8d-b735-f774bde9bd62",
    "Config": "{\"name\": \"__doc_b281db24_204433652648\", \"hostname\": \"192.168.1.100\", \"port\": 4222, \"username\": \"admin\", \"password\": \"password\", \"topic\": \"integration/data\", \"workersCount\": 100, \"enableTLS\": false, \"insecureSkipVerify\": false, \"maxReconnect\": 5, \"reconnectWait\": 2, \"connectTimeoutSeconds\": 2, \"flushTimeoutSeconds\": 2, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{"errors": [{"message": "topic has invalid char", "path": ["CreateInstance"]}], "data": null}

Create Instance - Oracle Smart Operations in Fusion Cloud SCM

POST {{edgeUrl}}/cc/v2

Provider ID: 943ecb8a-b215-4d48-ab51-2855302a3916 Provider Name: Oracle Smart Operations in Fusion Cloud SCM

Required properties: - method string — Method: Method (Oracle Fusion Cloud supports POST only) Options: POST - oAuth2ClientID string — OAuth2 - Client ID - oAuth2ClientSecret string — OAuth2 - Client Secret: OAuth2 - Client Secret Key - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - endpoint string — Endpoint - oAuth2TokenEndpoint string — OAuth2 - Token Endpoint: OAuth2 - Token Endpoint URL - name string — Name: Instance Name

Optional properties: - params object — Params: The request params - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - headers object — Headers: The request headers - mapping object — Mapping: The mapping - insecureSkipVerify boolean — Insecure skip verify: InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. - queueMode string — Queue Mode Options: lifo, fifo - responseTopic string — Response Topic: Nats response topic payload for All requests - oAuth2Scope string — OAuth2 - Scope: OAuth2 - Scope (comma separated value) - persistentStorage boolean — Persistent storage - requestTimeout integer — Request timeout: Request timeout in seconds - throttlingLimit integer — Throttling limit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "943ecb8a-b215-4d48-ab51-2855302a3916",
    "Config": "{\"name\": \"My Oracle Smart Operations in Fusion Cloud SCM Integration\", \"method\": \"POST\", \"endpoint\": \"/example/path\", \"oAuth2TokenEndpoint\": \"/example/path\", \"oAuth2ClientID\": \"my-client-id\", \"oAuth2ClientSecret\": \"password\", \"oAuth2Scope\": \"view,read\", \"headers\": {}, \"params\": {}, \"mapping\": {}, \"requestTimeout\": 10, \"insecureSkipVerify\": true, \"workersCount\": 100, \"responseTopic\": \"/response_topic\", \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "943ecb8a-b215-4d48-ab51-2855302a3916",
            "ProviderName": "Oracle Smart Operations in Fusion Cloud SCM",
            "Config": "{\"name\": \"My Oracle Smart Operations in Fusion Cloud SCM Integration\", \"method\": \"POST\", \"endpoint\": \"/example/path\", \"oAuth2TokenEndpoint\": \"/example/path\", \"oAuth2ClientID\": \"my-client-id\", \"oAuth2ClientSecret\": \"password\", \"oAuth2Scope\": \"view,read\", \"headers\": {}, \"params\": {}, \"mapping\": {}, \"requestTimeout\": 10, \"insecureSkipVerify\": true, \"workersCount\": 100, \"responseTopic\": \"/response_topic\", \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - OSI PI Historian (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 88a54a10-322a-4b9b-99e0-5a7b82a2f193 Provider Name: OSI PI Historian

Required properties: - password string — Password - tagNameFormat string — Point Name Format: Formatting directives for PI point name - publishCountThreshold integer — Publish Count Threshold: Publish count threshold (1 disables batching) - endpoint string — Endpoint: Resource Endpoint - name string — Name: Instance Name - username string — Username - subscribeInterval integer — Subscribe Interval (s): The subscription polling interval in seconds - publishDelayThreshold integer — Publish Delay Threshold (ms): Publish delay threshold in milliseconds (0 disables batching) - requestTimeout integer — Request Timeout (ms): HTTP Request Timeout in milliseconds - tagTypeFormat string — Point Datatype Format: Formatting directives for PI point datatype (AF type name) - maxSubscriptionEvents integer — Max Subscription Events: The maximum number of events processed per subscription poll (prioritised by most recent)

Optional properties: - persistentStorage boolean — Persistent storage - compression boolean — Gzip Compression: Enable gzip compression for OMF requests - piServer string — PI Data Server Name: Optional name of PI Data Archive server - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - insecureSkipVerify boolean — Insecure Skip Verify: Disable server certificate chain and host name verification - tagDescriptionFormat string — Point Description Format: Optional formatting directives for PI point description - timezone string — Data Timezone: UTC Timezone of Outbound data Options: UTC, Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Fort_Nelson, America/Fortaleza, America/Glace_Bay, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Inuvik, America/Iqaluit, America/Jamaica, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montserrat, America/Nassau, America/New_York, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Whitehorse, America/Winnipeg, America/Yakutat, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Riyadh, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faroe, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Ulyanovsk, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zurich, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis - dataSourceVersion string — Data Source Version: Optional version suffix for root datasource, requires non-empty DataSourceType - description string — Description: Instance Description - queueMode string — Queue Mode Options: lifo, fifo - caCert string — CA Certificate: CA certificate can be added here. It can also be added to system wide certificate list. - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - checkTags boolean — Check Tags: Check if point name exists before attempting to create new when writing - dataSourceType string — Data Source Type: Optional root name of datasource for PI points

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "88a54a10-322a-4b9b-99e0-5a7b82a2f193",
    "Config": "{\"name\": \"My OSI PI Historian Integration\", \"description\": \"placeholder_description\", \"endpoint\": \"/example/path\", \"username\": \"admin\", \"password\": \"password\", \"insecureSkipVerify\": false, \"caCert\": \"\", \"timezone\": \"UTC\", \"dataSourceType\": \"DH\", \"dataSourceVersion\": \"1\", \"tagNameFormat\": \"$S$V.$D.$N\", \"tagTypeFormat\": \"TimeIndexed.$T.$S\", \"tagDescriptionFormat\": \"$P\", \"compression\": true, \"checkTags\": true, \"piServer\": \"192.168.1.100\", \"requestTimeout\": 1000, \"publishDelayThreshold\": 1000, \"publishCountThreshold\": 50, \"subscribeInterval\": 1, \"maxSubscriptionEvents\": 100, \"workersCount\": 1, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"throttlingLimit\": 0, \"database\": \"\", \"afServer\": \"\"}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "88a54a10-322a-4b9b-99e0-5a7b82a2f193",
            "ProviderName": "OSI PI Historian",
            "Config": "{\"name\": \"My OSI PI Historian Integration\", \"description\": \"placeholder_description\", \"endpoint\": \"/example/path\", \"username\": \"admin\", \"password\": \"password\", \"insecureSkipVerify\": false, \"caCert\": \"\", \"timezone\": \"UTC\", \"dataSourceType\": \"DH\", \"dataSourceVersion\": \"1\", \"tagNameFormat\": \"$S$V.$D.$N\", \"tagTypeFormat\": \"TimeIndexed.$T.$S\", \"tagDescriptionFormat\": \"$P\", \"compression\": true, \"checkTags\": true, \"piServer\": \"192.168.1.100\", \"requestTimeout\": 1000, \"publishDelayThreshold\": 1000, \"publishCountThreshold\": 50, \"subscribeInterval\": 1, \"maxSubscriptionEvents\": 100, \"workersCount\": 1, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1, \"throttlingLimit\": 0, \"database\": \"\", \"afServer\": \"\"}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - REST API (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: 1532a2b5-590f-43d3-9faf-35df646890de Provider Name: REST API

Required properties: - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages. Check information above for details. - name string — Name: Instance Name - endpoint string — Endpoint - method string — Method Options: GET, POST, PUT, DELETE

Optional properties: - throttlingLimit integer — Throttling limit - mapping object — Mapping: The mapping - oAuth2ClientID string — OAuth2 - Client ID - persistentStorage boolean — Persistent storage - insecureSkipVerify boolean — Insecure skip verify: InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name. - oAuth2Scope string — OAuth2 - Scope: OAuth2 - Scope (comma separated value) - oAuth2TokenEndpoint string — OAuth2 - Token Endpoint: OAuth2 - Token Endpoint URL - queueMode string — Queue Mode Options: lifo, fifo - requestTimeout integer — Request timeout: Request timeout in seconds - oAuth2ClientSecret string — OAuth2 - Client Secret: OAuth2 - Client Secret Key - params object — Params: The request params - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - headers object — Headers: The request headers

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "1532a2b5-590f-43d3-9faf-35df646890de",
    "Config": "{\"name\": \"My REST API Integration\", \"method\": \"POST\", \"endpoint\": \"/example/path\", \"headers\": {}, \"params\": {}, \"mapping\": {}, \"requestTimeout\": 10, \"insecureSkipVerify\": true, \"workersCount\": 100, \"oAuth2TokenEndpoint\": \"/example/path\", \"oAuth2ClientSecret\": \"password\", \"oAuth2ClientID\": \"my-client-id\", \"oAuth2Scope\": \"view,read\", \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "1532a2b5-590f-43d3-9faf-35df646890de",
            "ProviderName": "REST API",
            "Config": "{\"name\": \"My REST API Integration\", \"method\": \"POST\", \"endpoint\": \"/example/path\", \"headers\": {}, \"params\": {}, \"mapping\": {}, \"requestTimeout\": 10, \"insecureSkipVerify\": true, \"workersCount\": 100, \"oAuth2TokenEndpoint\": \"/example/path\", \"oAuth2ClientSecret\": \"password\", \"oAuth2ClientID\": \"my-client-id\", \"oAuth2Scope\": \"view,read\", \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Snowflake Snowpipe Stream

POST {{edgeUrl}}/cc/v2

Provider ID: acbc4d51-d2e9-4370-bb7a-3d894d7ec24c Provider Name: Snowflake Snowpipe Stream

Required properties: - schema string — Schema: Schema Name - privateKey string — Private Key: PEM-encoded RSA private key for JWT authentication with the Snowflake Snowpipe REST API - username string — Username: Snowflake username used for key-pair authentication - account string — Account: Snowflake account identifier (e.g. xy12345.us-east-1) - tableName string — Table Name - database string — Database: Database Name - name string — Name: User defined name of connector instance

Optional properties: - requestTimeoutSec integer — Request Timeout (sec): HTTP request timeout in seconds for Snowpipe REST API calls - persistentStorage boolean — Persistent storage - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - throttlingLimit integer — Throttling limit - privateKeyPassphrase string — Private Key Passphrase: Passphrase for the encrypted private key. Leave empty if the private key is not encrypted. - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - queueMode string — Queue Mode Options: lifo, fifo

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "acbc4d51-d2e9-4370-bb7a-3d894d7ec24c",
    "Config": "{\"name\": \"My Snowflake Snowpipe Stream Integration\", \"account\": \"xy12345.us-east-1\", \"username\": \"admin\", \"privateKey\": \"<certificate>\", \"privateKeyPassphrase\": \"<certificate>\", \"database\": \"mydb\", \"schema\": \"myschema\", \"tableName\": \"mytable\", \"requestTimeoutSec\": 30, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "acbc4d51-d2e9-4370-bb7a-3d894d7ec24c",
            "ProviderName": "Snowflake Snowpipe Stream",
            "Config": "{\"name\": \"My Snowflake Snowpipe Stream Integration\", \"account\": \"xy12345.us-east-1\", \"username\": \"admin\", \"privateKey\": \"<certificate>\", \"privateKeyPassphrase\": \"<certificate>\", \"database\": \"mydb\", \"schema\": \"myschema\", \"tableName\": \"mytable\", \"requestTimeoutSec\": 30, \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - Splunk (Gen 1)

POST {{edgeUrl}}/cc/v2

Provider ID: aa1886dd-260d-4aad-b0d1-b9c49e814956 Provider Name: Splunk

Required properties: - useSSL boolean — Use SSL - hostname string — Hostname - name string — Name: Instance Name - token string — Token: Splunk token - topic string — Endpoint: Splunk endpoint - port integer — Port: Port of splunk host.

Optional properties: - workersCount integer — Parallel Publish Count: The number of simultaneously publishing messages - plSizeLimitGB integer — Persistent storage size limit: Persistent storage size limit in GB - queueMode string — Queue Mode Options: lifo, fifo - persistentStorage boolean — Persistent storage - throttlingLimit integer — Throttling limit

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Config
        Enabled
        ErrorLogging
        TagSyncEnabled
        System
        Online
        Status
        SizeOnDisk
        ErrCode
        ErrMsg
    }
}

Variables

{
  "input": {
    "ProviderID": "aa1886dd-260d-4aad-b0d1-b9c49e814956",
    "Config": "{\"name\": \"My Splunk Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8088, \"useSSL\": true, \"topic\": \"integration/data\", \"token\": \"password\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": false
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateInstance": {
            "InstanceID": "<generated-uuid>",
            "ProviderID": "aa1886dd-260d-4aad-b0d1-b9c49e814956",
            "ProviderName": "Splunk",
            "Config": "{\"name\": \"My Splunk Integration\", \"hostname\": \"192.168.1.100\", \"port\": 8088, \"useSSL\": true, \"topic\": \"integration/data\", \"token\": \"password\", \"workersCount\": 1, \"throttlingLimit\": 0, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"plSizeLimitMB\": 1024, \"plSizeLimitGB\": 1}",
            "Enabled": false,
            "ErrorLogging": false,
            "TagSyncEnabled": false,
            "System": false,
            "Online": false,
            "Status": "DISABLED",
            "SizeOnDisk": 0,
            "ErrCode": null,
            "ErrMsg": null
        }
    }
}

Create Instance - AMQP

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. AMQP Gen 2

ProviderID: cfc74724-3820-4d1f-bc0c-0b55308df3ab

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

This provider selects its transport with connectionType (tcp | ssl), rather than through separate TCP and SSL providers.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "cfc74724-3820-4d1f-bc0c-0b55308df3ab",
    "Config": "{\"certificate\": \"{{cc_secret}}\", \"connectionType\": \"tcp\", \"exchangeAutoDelete\": false, \"exchangeInternal\": false, \"persistentStorage\": true, \"username\": \"<username>\", \"exchange\": \"<exchange>\", \"exchangeNoWait\": false, \"exchangeType\": \"direct\", \"hostname\": \"192.168.1.100\", \"iso8601Timestamp\": false, \"password\": \"{{cc_secret}}\", \"queueMode\": \"lifo\", \"routingKey\": \"{{cc_secret}}\", \"caCert\": \"{{cc_secret}}\", \"name\": \"api-example\", \"privateKey\": \"{{cc_secret}}\", \"virtualHost\": \"192.168.1.100\", \"workersCount\": 1, \"exchangeDurable\": true, \"plSizeLimitGB\": 1, \"plSizeLimitMB\": 1024, \"port\": 5672, \"throttlingLimit\": 0}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - AWS IoT SiteWise

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. AWS IoT SiteWise Gen 2

ProviderID: defbecfe-c7c0-455f-bfda-e4f4498fd2a0

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "defbecfe-c7c0-455f-bfda-e4f4498fd2a0",
    "Config": "{\"workersCount\": 1, \"accessKey\": \"{{cc_secret}}\", \"name\": \"api-example\", \"numberOfBatchMessagesToPublish\": 1, \"plSizeLimitGB\": 1, \"secretAccessKey\": \"{{cc_secret}}\", \"subscribeIntervalSeconds\": 1, \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"queueMode\": \"lifo\", \"region\": \"<region>\", \"throttlingLimit\": 0}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Cognite

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. Cognite Gen 2

ProviderID: 468fcd36-4a73-43a6-b3a5-d1df493d6422

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "468fcd36-4a73-43a6-b3a5-d1df493d6422",
    "Config": "{\"workersCount\": 1, \"cluster\": \"<cluster>\", \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"projectID\": \"<projectID>\", \"subscribeIntervalSeconds\": 1, \"throttlingLimit\": 0, \"clientID\": \"<clientID>\", \"clientSecret\": \"{{cc_secret}}\", \"name\": \"api-example\", \"plSizeLimitGB\": 1, \"queueMode\": \"lifo\", \"scope\": \"<scope>\", \"tenantID\": \"<tenantID>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Microsoft SQL Server

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. DB - Microsoft SQL Server - Gen 2

ProviderID: 3474926c-eda9-4fbb-965d-c1ea76ea42ff

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "3474926c-eda9-4fbb-965d-c1ea76ea42ff",
    "Config": "{\"bulkSize\": 0, \"createTable\": false, \"database\": \"<database>\", \"maxTransactionSize\": 100, \"plSizeLimitMB\": 1024, \"queueMode\": \"lifo\", \"table\": \"<table>\", \"throttlingLimit\": 0, \"hostname\": \"192.168.1.100\", \"password\": \"{{cc_secret}}\", \"plSizeLimitGB\": 1, \"username\": \"<username>\", \"bulkInsertMode\": \"values\", \"mapping\": \"<mapping>\", \"name\": \"api-example\", \"persistentStorage\": true, \"workersCount\": 1, \"caCert\": \"{{cc_secret}}\", \"commitTimeout\": 1000, \"encrypt\": \"false\", \"port\": 1433, \"schema\": \"dbo\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - MySQL

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. DB - MySQL - Gen 2

ProviderID: a9221fea-bb2e-40a5-8f3c-07968b809301

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "a9221fea-bb2e-40a5-8f3c-07968b809301",
    "Config": "{\"certificate\": \"{{cc_secret}}\", \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"username\": \"<username>\", \"bulkSize\": 0, \"port\": 3306, \"sslMode\": \"disable\", \"workersCount\": 1, \"commitTimeout\": 1000, \"createTable\": false, \"database\": \"<database>\", \"maxTransactionSize\": 100, \"name\": \"api-example\", \"plSizeLimitGB\": 1, \"throttlingLimit\": 0, \"caCert\": \"{{cc_secret}}\", \"hostname\": \"192.168.1.100\", \"mapping\": \"<mapping>\", \"password\": \"{{cc_secret}}\", \"privateKey\": \"{{cc_secret}}\", \"queueMode\": \"lifo\", \"table\": \"<table>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - PostgreSQL

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. DB - PostgreSQL - Gen 2

ProviderID: 7c4e5f8a-9b2d-4a3e-b1c6-8d7f9e2a5b4c

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "7c4e5f8a-9b2d-4a3e-b1c6-8d7f9e2a5b4c",
    "Config": "{\"privateKey\": \"{{cc_secret}}\", \"workersCount\": 1, \"bulkSize\": 0, \"caCert\": \"{{cc_secret}}\", \"certificate\": \"{{cc_secret}}\", \"name\": \"api-example\", \"password\": \"{{cc_secret}}\", \"plSizeLimitMB\": 1024, \"port\": 5432, \"throttlingLimit\": 0, \"database\": \"<database>\", \"hostname\": \"192.168.1.100\", \"sslMode\": \"disable\", \"table\": \"<table>\", \"username\": \"<username>\", \"commitTimeout\": 1000, \"maxTransactionSize\": 100, \"persistentStorage\": true, \"queueMode\": \"lifo\", \"createTable\": false, \"mapping\": \"<mapping>\", \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Google Cloud Pub/Sub

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. Google Cloud Pub/Sub Gen 2

ProviderID: 374a1bc8-184d-48ba-9b98-52386172088f

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "374a1bc8-184d-48ba-9b98-52386172088f",
    "Config": "{\"throttlingLimit\": 0, \"workersCount\": 1, \"publishCountThreshold\": 0, \"plSizeLimitMB\": 1024, \"queueMode\": \"lifo\", \"topic\": \"example/topic\", \"plSizeLimitGB\": 1, \"publishByteThreshold\": 0, \"publishDelayThresholdMs\": 0, \"connectTimeoutSeconds\": 5, \"key\": \"{{cc_secret}}\", \"meta\": \"<meta>\", \"name\": \"api-example\", \"persistentStorage\": true, \"privateKeyID\": \"{{cc_secret}}\", \"projectId\": \"<projectId>\", \"ackDeadlineSec\": 20, \"clientEmail\": \"<clientEmail>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Kafka

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. Kafka Gen 2

ProviderID: f0c40ed3-b354-4188-849a-6ceeb2f3b1c1

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

This provider selects its transport with connectionType (tcp | ssl), rather than through separate TCP and SSL providers.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "f0c40ed3-b354-4188-849a-6ceeb2f3b1c1",
    "Config": "{\"password\": \"{{cc_secret}}\", \"plSizeLimitGB\": 1, \"autoCreateTopic\": false, \"caCert\": \"{{cc_secret}}\", \"privateKey\": \"{{cc_secret}}\", \"brokers\": \"192.168.1.100\", \"insecureSkipVerify\": false, \"name\": \"api-example\", \"plSizeLimitMB\": 1024, \"certificate\": \"{{cc_secret}}\", \"saslMechanism\": \"SCRAM-SHA-256\", \"throttlingLimit\": 0, \"topic\": \"example/topic\", \"persistentStorage\": true, \"connectionType\": \"tcp\", \"clientId\": \"go-client\", \"queueMode\": \"lifo\", \"username\": \"<username>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - MQTT - IBM Watson over SSL

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. MQTT - IBM Watson over SSL Gen 2

ProviderID: 1009066e-58be-455b-9767-c196ae876d4e

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

This provider selects its transport with connectionType (ssl), rather than through separate TCP and SSL providers.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "1009066e-58be-455b-9767-c196ae876d4e",
    "Config": "{\"password\": \"{{cc_secret}}\", \"queueMode\": \"lifo\", \"throttlingLimit\": 0, \"willPayloadType\": \"string\", \"hostname\": \"192.168.1.100\", \"name\": \"api-example\", \"pingTimeout\": 7, \"privateKey\": \"{{cc_secret}}\", \"willPayload\": \"<willPayload>\", \"willTopic\": \"example/topic\", \"workersCount\": 100, \"caCert\": \"{{cc_secret}}\", \"certificate\": \"{{cc_secret}}\", \"connectionType\": \"ssl\", \"plSizeLimitGB\": 1, \"plSizeLimitMB\": 1024, \"topic\": \"example/topic\", \"username\": \"<username>\", \"willRetained\": false, \"persistentStorage\": true, \"port\": 8883, \"qos\": 1, \"willQoS\": 1, \"clientId\": \"<clientId>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - MQTT - v5 Generic

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. MQTT - v5 Generic Gen 2

ProviderID: 6d460871-d540-491d-89ea-909b783a222a

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

This provider selects its transport with connectionType (tcp | ssl), rather than through separate TCP and SSL providers.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "6d460871-d540-491d-89ea-909b783a222a",
    "Config": "{\"queueMode\": \"lifo\", \"throttlingLimit\": 0, \"insecureVerify\": false, \"privateKey\": \"{{cc_secret}}\", \"password\": \"{{cc_secret}}\", \"userProperties\": \"<userProperties>\", \"certificate\": \"{{cc_secret}}\", \"connectionType\": \"tcp\", \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"caCert\": \"{{cc_secret}}\", \"plSizeLimitGB\": 1, \"clientId\": \"<clientId>\", \"name\": \"api-example\", \"port\": 1883, \"qos\": 1, \"username\": \"<username>\", \"hostname\": \"192.168.1.100\", \"topic\": \"example/topic\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - MongoDB v4+

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. MongoDB v4+ Gen 2

ProviderID: 3b1e4a2d-6c8f-4b9a-9d7e-5e2a1c3f4b8d

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "3b1e4a2d-6c8f-4b9a-9d7e-5e2a1c3f4b8d",
    "Config": "{\"plSizeLimitGB\": 1, \"bulkSize\": 0, \"certificate\": \"{{cc_secret}}\", \"name\": \"api-example\", \"port\": 27017, \"sslMode\": \"disable\", \"throttlingLimit\": 0, \"authDatabase\": \"admin\", \"caCert\": \"{{cc_secret}}\", \"collection\": \"<collection>\", \"createCollection\": false, \"database\": \"<database>\", \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"scheme\": \"mongodb\", \"mapping\": \"<mapping>\", \"password\": \"{{cc_secret}}\", \"privateKey\": \"{{cc_secret}}\", \"queueMode\": \"lifo\", \"username\": \"<username>\", \"workersCount\": 1, \"commitTimeout\": 1000, \"hostname\": \"192.168.1.100\", \"maxTransactionSize\": 100}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - REST API

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. REST API - Gen 2

ProviderID: 3a8f7c1e-5a4c-4cf4-9b8e-7a2d0d3c1f10

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "3a8f7c1e-5a4c-4cf4-9b8e-7a2d0d3c1f10",
    "Config": "{\"apiKeyValue\": \"{{cc_secret}}\", \"endpoint\": \"192.168.1.100\", \"oAuth2ClientID\": \"<oAuth2ClientID>\", \"plSizeLimitGB\": 1, \"requestTimeout\": 30, \"responseMode\": \"body_only\", \"responseTopic\": \"example/topic\", \"oAuth2ClientSecret\": \"{{cc_secret}}\", \"oAuth2TokenEndpoint\": \"{{cc_secret}}\", \"workersCount\": 1, \"apiKeyHeader\": \"{{cc_secret}}\", \"authentication\": \"none\", \"plSizeLimitMB\": 1024, \"retryBackoff\": \"exponential\", \"headers\": \"<headers>\", \"insecureSkipVerify\": false, \"params\": \"<params>\", \"password\": \"{{cc_secret}}\", \"persistentStorage\": true, \"queueMode\": \"lifo\", \"clientCert\": \"<certificate>\", \"method\": \"POST\", \"name\": \"api-example\", \"retryCount\": 0, \"caCert\": \"<certificate>\", \"clientKey\": \"{{cc_secret}}\", \"mapping\": \"<mapping>\", \"throttlingLimit\": 0, \"bearerToken\": \"{{cc_secret}}\", \"oAuth2Scope\": \"<oAuth2Scope>\", \"username\": \"<username>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Splunk

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. Splunk Gen 2

ProviderID: c3e1cdf0-7824-42a6-880f-e54d47d6041f

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "c3e1cdf0-7824-42a6-880f-e54d47d6041f",
    "Config": "{\"useSSL\": true, \"hostname\": \"192.168.1.100\", \"name\": \"api-example\", \"plSizeLimitMB\": 1024, \"queueMode\": \"lifo\", \"topic\": \"services/collector/event\", \"workersCount\": 1, \"persistentStorage\": true, \"plSizeLimitGB\": 1, \"port\": 8088, \"throttlingLimit\": 0, \"token\": \"{{cc_secret}}\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Aveva DataHub

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. Aveva Data Hub Gen 2

ProviderID: d8451005-c405-415f-ac4c-82c19c1cb5ca

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "d8451005-c405-415f-ac4c-82c19c1cb5ca",
    "Config": "{\"endpoint\": \"192.168.1.100\", \"tenantId\": \"<tenantId>\", \"throttlingLimit\": 0, \"workersCount\": 1, \"description\": \"<description>\", \"name\": \"api-example\", \"namespace\": \"<namespace>\", \"persistentStorage\": true, \"plSizeLimitGB\": 1, \"plSizeLimitMB\": 1024, \"queueMode\": \"lifo\", \"stream\": \"<stream>\", \"clientId\": \"<clientId>\", \"clientSecret\": \"{{cc_secret}}\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - MaintainX API

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. MaintainX API

ProviderID: d0e3f2c4-4a8b-4a12-9c37-2b9f0a3d5c8b

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "d0e3f2c4-4a8b-4a12-9c37-2b9f0a3d5c8b",
    "Config": "{\"connectionCheckingInterval\": 300, \"plSizeLimitMB\": 1024, \"endpoint\": \"https://api.getmaintainx.com/v1\", \"persistentStorage\": true, \"retryBackoff\": \"exponential\", \"workersCount\": 100, \"bearerToken\": \"{{cc_secret}}\", \"organizationId\": \"<organizationId>\", \"queueMode\": \"lifo\", \"requestTimeout\": 10, \"responseMode\": \"body_only\", \"responseTopic\": \"example/topic\", \"name\": \"api-example\", \"plSizeLimitGB\": 1, \"retryCount\": 0, \"throttlingLimit\": 0}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - OSI PI Historian

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. OSI PI Historian Gen 2

ProviderID: 4663b683-0bfb-4bad-a51d-274b7bd15594

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "4663b683-0bfb-4bad-a51d-274b7bd15594",
    "Config": "{\"maxSubscriptionEvents\": 100, \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"tagNameFormat\": \"$S$V.$D.$N\", \"tagTypeFormat\": \"TimeIndexed.$T.$S\", \"database\": \"<database>\", \"description\": \"<description>\", \"subscribeInterval\": 1, \"throttlingLimit\": 0, \"timezone\": \"UTC\", \"username\": \"<username>\", \"workersCount\": 1, \"dataSourceVersion\": \"1\", \"endpoint\": \"192.168.1.100\", \"name\": \"api-example\", \"password\": \"{{cc_secret}}\", \"publishCountThreshold\": 50, \"publishDelayThreshold\": 1000, \"queueMode\": \"lifo\", \"tagDescriptionFormat\": \"$P\", \"afServer\": \"192.168.1.100\", \"caCert\": \"{{cc_secret}}\", \"checkTags\": true, \"dataSourceType\": \"DH\", \"insecureSkipVerify\": false, \"piServer\": \"192.168.1.100\", \"plSizeLimitGB\": 1, \"requestTimeout\": 1000}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - SAP Hana Cloud

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. SAP Hana Cloud

ProviderID: 0f3b6c4a-5d2e-4a71-9c8f-1e6b2d40a973

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "0f3b6c4a-5d2e-4a71-9c8f-1e6b2d40a973",
    "Config": "{\"authMethod\": \"password\", \"clientCert\": \"{{cc_secret}}\", \"schema\": \"<schema>\", \"throttlingLimit\": 0, \"workersCount\": 1, \"mapping\": \"<mapping>\", \"maxTransactionSize\": 100, \"name\": \"api-example\", \"bulkSize\": 0, \"connectionTimeout\": 10, \"createTable\": false, \"databaseName\": \"<databaseName>\", \"hostname\": \"192.168.1.100\", \"clientKey\": \"{{cc_secret}}\", \"password\": \"{{cc_secret}}\", \"persistentStorage\": true, \"plSizeLimitGB\": 1, \"plSizeLimitMB\": 1024, \"port\": 443, \"tlsMode\": \"verify-full\", \"tlsServerName\": \"192.168.1.100\", \"allowDmlOnExecuteCommand\": false, \"caCert\": \"{{cc_secret}}\", \"commitTimeout\": 1000, \"queueMode\": \"lifo\", \"table\": \"<table>\", \"username\": \"<username>\"}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - TimescaleDB

POST {{edgeUrl}}/cc/v2

New provider in 4.2.x. TimescaleDB

ProviderID: 2afd221e-1538-4eae-85a0-a7ce76e2368c

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "2afd221e-1538-4eae-85a0-a7ce76e2368c",
    "Config": "{\"certificate\": \"{{cc_secret}}\", \"enableJsonPath\": false, \"maxTransactionSize\": 100, \"password\": \"{{cc_secret}}\", \"port\": 5432, \"queueMode\": \"lifo\", \"createTable\": false, \"mapping\": \"<mapping>\", \"name\": \"api-example\", \"plSizeLimitGB\": 1, \"plSizeLimitMB\": 1024, \"privateKey\": \"{{cc_secret}}\", \"throttlingLimit\": 0, \"caCert\": \"{{cc_secret}}\", \"commitTimeout\": 1000, \"hostname\": \"192.168.1.100\", \"workersCount\": 1, \"database\": \"<database>\", \"persistentStorage\": true, \"sslMode\": \"disable\", \"table\": \"<table>\", \"username\": \"<username>\", \"bulkSize\": 0}",
    "Enabled": false,
    "ErrorLogging": true
  }
}

Create Instance - Litmus Unify

POST {{edgeUrl}}/cc/v2

New provider in 4.4.x. Litmus Unify

ProviderID: 7c1f3a92-5b8e-4d6a-9f27-0a4c8e35b1d3

Config is a JSON string, not an object. The values below come from the provider's own schema defaults, so replace the placeholders before sending. Fetch the authoritative property list with Get Provider Schema.

This provider selects its transport with connectionType (mqtt | mqtts | ws | wss), rather than through separate TCP and SSL providers.

Created with Enabled: false so the instance does not attempt to connect until you have filled in real credentials.

Request Body

GraphQL Query

mutation CreateInstance($input: CreateInstanceRequest!) {
    CreateInstance(input: $input) {
        InstanceID
        ProviderID
        ProviderName
        Enabled
        ErrorLogging
        ExecCommandEnabled
        Status
    }
}

Variables

{
  "input": {
    "ProviderID": "7c1f3a92-5b8e-4d6a-9f27-0a4c8e35b1d3",
    "Config": "{\"caCert\": \"{{cc_secret}}\", \"insecureSkipVerify\": false, \"throttlingLimit\": 0, \"path\": \"<path>\", \"UnifyClientID\": \"<UnifyClientID>\", \"persistentStorage\": true, \"plSizeLimitMB\": 1024, \"port\": 0, \"queueMode\": \"lifo\", \"token\": \"{{cc_secret}}\", \"workersCount\": 100, \"connectionType\": \"mqtt\", \"name\": \"api-example\", \"plSizeLimitGB\": 1}",
    "Enabled": false,
    "ErrorLogging": true
  }
}