Litmus Edge 4.4.x - Integration: Provider Schemas Reference
Provider Schema - AMQP
POST {{edgeUrl}}/cc/v2
AMQP — Provider Schema
Provider ID: cfc74724-3820-4d1f-bc0c-0b55308df3ab
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
exchangeDurable |
boolean | Exchange durable | No | True |
- |
exchangeNoWait |
boolean | Exchange no wait | No | False |
- |
port |
integer | Port | Yes | 5672 |
- |
routingKey |
string | Routing key | Yes | - | - |
caCert |
string | CA Certificate | Yes, when connectionType is ssl |
`` | - |
certificate |
string | Certificate | No | `` | - |
connectionType |
string | Connection Type | Yes | tcp |
tcp, ssl |
exchangeAutoDelete |
boolean | Exchange auto delete | No | False |
- |
iso8601Timestamp |
boolean | ISO8601 timestamp | No | False |
- |
name |
string | Name | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
privateKey |
string | Private key | No | `` | - |
exchangeInternal |
boolean | Exchange internal | No | False |
- |
hostname |
string | Hostname | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | Yes, when authType is plain |
- | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
exchangeType |
string | Exchange type | No | direct |
direct, fanout, topic, x-custom |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
virtualHost |
string | Virtual host | No | - | - |
authType |
string | Authentication | No | plain |
plain, anonymous |
exchange |
string | Exchange | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "cfc74724-3820-4d1f-bc0c-0b55308df3ab"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/amqp.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "exchangeDurable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange durable",
"LabelCode": "amqp.exchangeDurable.label",
"ToolTip": "Declare the exchange as durable",
"ToolTipCode": "amqp.exchangeDurable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeNoWait",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange no wait",
"LabelCode": "amqp.exchangeNoWait.label",
"ToolTip": "Declare the exchange without waiting for server confirmation",
"ToolTipCode": "amqp.exchangeNoWait.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5672,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "amqp.port.label",
"ToolTip": "TCP port the AMQP broker listens on. Defaults to 5672.",
"ToolTipCode": "amqp.port.tooltip",
"Example": "5672",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "routingKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Routing key",
"LabelCode": "amqp.routingKey.label",
"ToolTip": "Default routing key for published messages",
"ToolTipCode": "amqp.routingKey.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "amqp.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "amqp.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "amqp.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the AMQP broker. Paste the PEM-encoded certificate here.",
"ToolTipCode": "amqp.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "tcp",
"Minimum": null,
"Maximum": null,
"Enum": [
"tcp",
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "generic.connectionType.label",
"ToolTip": "Choose tcp for an unencrypted connection or ssl for a TLS-encrypted connection to the AMQP broker.",
"ToolTipCode": "generic.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeAutoDelete",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange auto delete",
"LabelCode": "amqp.exchangeAutoDelete.label",
"ToolTip": "Delete the exchange when no longer used",
"ToolTipCode": "amqp.exchangeAutoDelete.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "iso8601Timestamp",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "ISO8601 timestamp",
"LabelCode": "amqp.iso8601Timestamp.label",
"ToolTip": "Convert timestamp to ISO8601",
"ToolTipCode": "amqp.iso8601Timestamp.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "amqp.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "amqp.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "amqp.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "exchangeInternal",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange internal",
"LabelCode": "amqp.exchangeInternal.label",
"ToolTip": "Declare the exchange as internal",
"ToolTipCode": "amqp.exchangeInternal.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "amqp.hostname.label",
"ToolTip": "IP Address or hostname of AMQP broker (must be reachable from Edge system)",
"ToolTipCode": "amqp.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "amqp.username.label",
"ToolTip": "Username for authenticating with the AMQP broker",
"ToolTipCode": "amqp.username.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authType",
"FieldValues": [
"plain"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "direct",
"Minimum": null,
"Maximum": null,
"Enum": [
"direct",
"fanout",
"topic",
"x-custom"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange type",
"LabelCode": "amqp.exchangeType.label",
"ToolTip": "Exchange type: direct, fanout, topic or x-custom",
"ToolTipCode": "amqp.exchangeType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "amqp.password.label",
"ToolTip": "Password for authenticating with the AMQP broker",
"ToolTipCode": "amqp.password.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authType",
"FieldValues": [
"plain"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "virtualHost",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Virtual host",
"LabelCode": "amqp.virtualHost.label",
"ToolTip": "AMQP virtual host to connect to; it scopes the exchanges and queues this connector uses.",
"ToolTipCode": "amqp.virtualHost.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "plain",
"Minimum": null,
"Maximum": null,
"Enum": [
"plain",
"anonymous"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Authentication",
"LabelCode": "amqp.authType.label",
"ToolTip": "Authentication mode: plain logs in with username and password; anonymous connects without credentials (SASL ANONYMOUS, the broker must allow it)",
"ToolTipCode": "amqp.authType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchange",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange",
"LabelCode": "amqp.exchange.label",
"ToolTip": "AMQP exchange to publish to and bind subscriptions on; empty uses the default exchange",
"ToolTipCode": "amqp.exchange.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"connectionType",
"hostname",
"port",
"routingKey"
],
"Order": [
"name",
"connectionType",
"hostname",
"port",
"caCert",
"certificate",
"privateKey",
"virtualHost",
"authType",
"username",
"password",
"exchange",
"exchangeType",
"exchangeDurable",
"exchangeAutoDelete",
"exchangeInternal",
"exchangeNoWait",
"routingKey",
"iso8601Timestamp",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - AMQP SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
AMQP SSL (Gen 1) — Provider Schema
Provider ID: 900f51b2-936b-43c2-9af8-d65046f312a5
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
virtualHost |
string | Virtual host | No | - | - |
exchange |
string | Exchange | No | - | - |
exchangeAutoDelete |
boolean | Exchange auto delete | No | False |
- |
exchangeNoWait |
boolean | Exchange no wait | No | False |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
exchangeDurable |
boolean | Exchange durable | No | True |
- |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
certificate |
string | Certificate | No | `` | - |
exchangeType |
string | exchangeType | No | direct |
direct, fanout, topic, x-custom |
iso8601Timestamp |
boolean | ISO8601 timestamp | No | False |
- |
port |
integer | Port | Yes | 5671 |
- |
username |
string | Username | No | - | - |
caCert |
string | CA Certificate | Yes | `` | - |
exchangeInternal |
boolean | Exchange internal | No | False |
- |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
privateKey |
string | Private key | No | `` | - |
routingKey |
string | Routing key | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "900f51b2-936b-43c2-9af8-d65046f312a5"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/amqp-ssl.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "virtualHost",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Virtual host",
"LabelCode": "amqp.virtualHost.label",
"ToolTip": "AMQP virtual host to connect to.",
"ToolTipCode": "amqp.virtualHost.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchange",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange",
"LabelCode": "amqp.exchange.label",
"ToolTip": "AMQP exchange messages are published to. Exchanges route messages to queues based on the exchange type and routing key. Leave empty to use the default exchange.",
"ToolTipCode": "amqp.exchange.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeAutoDelete",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange auto delete",
"LabelCode": "amqp.exchangeAutoDelete.label",
"ToolTip": "When enabled, the exchange is automatically deleted once all queues have been unbound from it.",
"ToolTipCode": "amqp.exchangeAutoDelete.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeNoWait",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange no wait",
"LabelCode": "amqp.exchangeNoWait.label",
"ToolTip": "When enabled, the broker does not send a confirmation after exchange declaration. Errors may be reported asynchronously, so use with caution.",
"ToolTipCode": "amqp.exchangeNoWait.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeDurable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange durable",
"LabelCode": "amqp.exchangeDurable.label",
"ToolTip": "When enabled, the exchange survives broker restarts. Disable only for temporary exchanges that don't need to persist across restarts.",
"ToolTipCode": "amqp.exchangeDurable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "amqp.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "amqp.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the AMQP broker. Paste PEM-encoded certificate here.",
"ToolTipCode": "amqp.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "direct",
"Minimum": null,
"Maximum": null,
"Enum": [
"direct",
"fanout",
"topic",
"x-custom"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "exchangeType",
"LabelCode": "amqp.exchangeType.label",
"ToolTip": "Routing algorithm: direct = exact key match, fanout = broadcast to all bound queues, topic = wildcard pattern matching, x-custom = custom exchange plugin.",
"ToolTipCode": "amqp.exchangeType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "iso8601Timestamp",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "ISO8601 timestamp",
"LabelCode": "amqp.iso8601Timestamp.label",
"ToolTip": "When enabled, the message timestamp is converted to ISO 8601 format before the message is sent.",
"ToolTipCode": "amqp.iso8601Timestamp.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5671,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "amqp.port.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "5672",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "amqp.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "amqp.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "amqp.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeInternal",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange internal",
"LabelCode": "amqp.exchangeInternal.label",
"ToolTip": "When enabled, the exchange can only receive messages routed from other exchanges, not published directly by clients.",
"ToolTipCode": "amqp.exchangeInternal.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "amqp.hostname.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "amqp.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "amqp.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "amqp.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "routingKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Routing key",
"LabelCode": "amqp.routingKey.label",
"ToolTip": "Key used to route messages to queues.",
"ToolTipCode": "amqp.routingKey.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"routingKey",
"caCert"
],
"Order": [
"name",
"hostname",
"port",
"virtualHost",
"username",
"password",
"exchange",
"exchangeType",
"exchangeDurable",
"exchangeAutoDelete",
"exchangeInternal",
"exchangeNoWait",
"routingKey",
"iso8601Timestamp",
"caCert",
"certificate",
"privateKey",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - AMQP TCP (Gen 1)
POST {{edgeUrl}}/cc/v2
AMQP TCP (Gen 1) — Provider Schema
Provider ID: 800bfae1-9d30-4e90-932c-e646a7771c1b
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
exchangeDurable |
boolean | Exchange durable | No | True |
- |
name |
string | Name | Yes | - | - |
port |
integer | Port | Yes | 5672 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | No | - | - |
exchange |
string | Exchange | No | - | - |
exchangeInternal |
boolean | Exchange internal | No | False |
- |
exchangeType |
string | exchangeType | No | direct |
direct, fanout, topic, x-custom |
iso8601Timestamp |
boolean | ISO8601 timestamp | No | False |
- |
routingKey |
string | Routing key | Yes | - | - |
virtualHost |
string | Virtual host | No | - | - |
exchangeAutoDelete |
boolean | Exchange auto delete | No | False |
- |
exchangeNoWait |
boolean | Exchange no wait | No | False |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
hostname |
string | Hostname | Yes | - | - |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "800bfae1-9d30-4e90-932c-e646a7771c1b"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/amqp-ssl.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "exchangeDurable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange durable",
"LabelCode": "amqp.exchangeDurable.label",
"ToolTip": "When enabled, the exchange survives broker restarts. Disable only for temporary exchanges that don't need to persist across restarts.",
"ToolTipCode": "amqp.exchangeDurable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "amqp.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5672,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "amqp.port.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "5672",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "amqp.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchange",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange",
"LabelCode": "amqp.exchange.label",
"ToolTip": "AMQP exchange messages are published to. Exchanges route messages to queues based on the exchange type and routing key. Leave empty to use the default exchange.",
"ToolTipCode": "amqp.exchange.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeInternal",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange internal",
"LabelCode": "amqp.exchangeInternal.label",
"ToolTip": "When enabled, the exchange can only receive messages routed from other exchanges, not published directly by clients.",
"ToolTipCode": "amqp.exchangeInternal.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "direct",
"Minimum": null,
"Maximum": null,
"Enum": [
"direct",
"fanout",
"topic",
"x-custom"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "exchangeType",
"LabelCode": "amqp.exchangeType.label",
"ToolTip": "Routing algorithm: direct = exact key match, fanout = broadcast to all bound queues, topic = wildcard pattern matching, x-custom = custom exchange plugin.",
"ToolTipCode": "amqp.exchangeType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "iso8601Timestamp",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "ISO8601 timestamp",
"LabelCode": "amqp.iso8601Timestamp.label",
"ToolTip": "When enabled, the message timestamp is converted to ISO 8601 format before the message is sent.",
"ToolTipCode": "amqp.iso8601Timestamp.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "routingKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Routing key",
"LabelCode": "amqp.routingKey.label",
"ToolTip": "Key used to route messages to queues.",
"ToolTipCode": "amqp.routingKey.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "virtualHost",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Virtual host",
"LabelCode": "amqp.virtualHost.label",
"ToolTip": "AMQP virtual host to connect to.",
"ToolTipCode": "amqp.virtualHost.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeAutoDelete",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange auto delete",
"LabelCode": "amqp.exchangeAutoDelete.label",
"ToolTip": "When enabled, the exchange is automatically deleted once all queues have been unbound from it.",
"ToolTipCode": "amqp.exchangeAutoDelete.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "exchangeNoWait",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Exchange no wait",
"LabelCode": "amqp.exchangeNoWait.label",
"ToolTip": "When enabled, the broker does not send a confirmation after exchange declaration. Errors may be reported asynchronously, so use with caution.",
"ToolTipCode": "amqp.exchangeNoWait.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "amqp.hostname.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "amqp.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"routingKey"
],
"Order": [
"name",
"hostname",
"port",
"virtualHost",
"username",
"password",
"exchange",
"exchangeType",
"exchangeDurable",
"exchangeAutoDelete",
"exchangeInternal",
"exchangeNoWait",
"routingKey",
"iso8601Timestamp",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Aveva Data Hub (Gen 1)
POST {{edgeUrl}}/cc/v2
Aveva Data Hub (Gen 1) — Provider Schema
Provider ID: 1486437a-8208-4ec8-bb50-cf7f394fcf51
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
description |
string | Description | No | - | - |
name |
string | Name | Yes | - | - |
namespace |
string | Namespace | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
stream |
string | Stream Id | Yes | - | - |
tenantId |
string | Tenant Id | Yes | - | - |
clientSecret |
string | Client Secret | Yes | - | - |
endpoint |
string | Endpoint | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
clientId |
string | Client Id | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "1486437a-8208-4ec8-bb50-cf7f394fcf51"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/avevadatahub.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "description",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Description",
"LabelCode": "avevadatahub.description.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "avevadatahub.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "namespace",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Namespace",
"LabelCode": "avevadatahub.namespace.label",
"ToolTip": "ADH namespace where the target stream resides. Namespaces isolate streams and data within a tenant.",
"ToolTipCode": "avevadatahub.namespace.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "stream",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Stream Id",
"LabelCode": "avevadatahub.stream.label",
"ToolTip": "Identifier of the ADH stream data is written to. Must match an existing stream in the specified namespace.",
"ToolTipCode": "avevadatahub.stream.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tenantId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Tenant Id",
"LabelCode": "avevadatahub.tenantId.label",
"ToolTip": "AVEVA Data Hub tenant identifier.",
"ToolTipCode": "avevadatahub.tenantId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Secret",
"LabelCode": "avevadatahub.clientSecret.label",
"ToolTip": "OAuth2 client secret paired with the Client ID.",
"ToolTipCode": "avevadatahub.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "avevadatahub.endpoint.label",
"ToolTip": "URL of the AVEVA Data Hub (ADH) REST API endpoint.",
"ToolTipCode": "avevadatahub.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client Id",
"LabelCode": "avevadatahub.clientId.label",
"ToolTip": "OAuth2 client ID registered in AVEVA Data Hub for authentication.",
"ToolTipCode": "avevadatahub.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"clientId",
"clientSecret",
"tenantId",
"stream",
"namespace"
],
"Order": [
"name",
"description",
"endpoint",
"clientId",
"clientSecret",
"tenantId",
"stream",
"namespace",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Aveva DataHub
POST {{edgeUrl}}/cc/v2
Aveva DataHub — Provider Schema
Provider ID: d8451005-c405-415f-ac4c-82c19c1cb5ca
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
tenantId |
string | Tenant Id | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
description |
string | Description | No | - | - |
endpoint |
string | Endpoint | Yes | - | - |
name |
string | Name | Yes | - | - |
namespace |
string | Namespace | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
stream |
string | Stream Id | Yes | - | - |
clientId |
string | Client Id | Yes | - | - |
clientSecret |
string | Client Secret | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "d8451005-c405-415f-ac4c-82c19c1cb5ca"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/avevadatahub.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "tenantId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Tenant Id",
"LabelCode": "avevadatahub.tenantId.label",
"ToolTip": "Identifier of the AVEVA Data Hub tenant that owns the target namespace and stream. Found under Security > Clients.",
"ToolTipCode": "avevadatahub.tenantId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "description",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Description",
"LabelCode": "avevadatahub.description.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "avevadatahub.endpoint.label",
"ToolTip": "Regional AVEVA Data Hub service URL this connector sends to. Found under Security > Clients.",
"ToolTipCode": "avevadatahub.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "avevadatahub.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "namespace",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Namespace",
"LabelCode": "avevadatahub.namespace.label",
"ToolTip": "Namespace within the tenant that contains the target SDS stream.",
"ToolTipCode": "avevadatahub.namespace.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "stream",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Stream Id",
"LabelCode": "avevadatahub.stream.label",
"ToolTip": "Default Sequential Data Store (SDS) stream that outbound data is written to. Found under Data Management.",
"ToolTipCode": "avevadatahub.stream.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client Id",
"LabelCode": "avevadatahub.clientId.label",
"ToolTip": "Client ID of the credentials used to authenticate this connection. Found under Security > Clients.",
"ToolTipCode": "avevadatahub.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Secret",
"LabelCode": "avevadatahub.clientSecret.label",
"ToolTip": "Secret paired with the Client Id; both are required to authenticate. Created under Security > Clients.",
"ToolTipCode": "avevadatahub.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"clientId",
"clientSecret",
"tenantId",
"stream",
"namespace"
],
"Order": [
"name",
"description",
"endpoint",
"clientId",
"clientSecret",
"tenantId",
"stream",
"namespace",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - AWS IoT Core
POST {{edgeUrl}}/cc/v2
AWS IoT Core — Provider Schema
Provider ID: 8a7829cb-95cc-4ab8-9ed3-94fa99a8e4db
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
certificate |
string | Certificate | Yes | `` | - |
name |
string | Name | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
hostname |
string | Hostname | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
port |
integer | Port | No | 8883 |
- |
willTopic |
string | LWT topic | No | - | - |
caCert |
string | CA Certificate | No | `` | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
qos |
integer | QoS | No | 1 |
0, 1 |
topic |
string | Integration Topic | Yes | - | - |
willPayload |
string | LWT payload | No | - | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1 |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
clientId |
string | Client ID | No | - | - |
privateKey |
string | Private key | Yes | `` | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
willRetained |
boolean | LWT retained | No | False |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "8a7829cb-95cc-4ab8-9ed3-94fa99a8e4db"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-iotcore-mqtt-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "aws.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the MQTT broker. Paste the PEM-encoded certificate here.",
"ToolTipCode": "aws.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "aws.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Amazon IoT Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "aws.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "aws.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "aws.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "aws.hostname.tooltip",
"Example": "a1o8e9c82gegra.iot.us-east-2.amazonaws.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "aws.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "aws.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "aws.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "aws.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "aws.caCert.label",
"ToolTip": "Amazon Root CA certificate (optional - uses system trust store if not provided).",
"ToolTipCode": "aws.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "aws.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once. AWS IoT Core does not support QoS 2.",
"ToolTipCode": "aws.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "aws.topic.label",
"ToolTip": "AWS IoT Core topic to publish messages to. Follows MQTT topic conventions.",
"ToolTipCode": "aws.topic.tooltip",
"Example": "/events",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "aws.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "aws.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "aws.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "aws.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "aws.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "aws.clientId.label",
"ToolTip": "Client ID is required by MQTT server.",
"ToolTipCode": "aws.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "aws.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "aws.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "aws.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and immediately delivers it to any new subscriber on that topic.",
"ToolTipCode": "aws.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"topic",
"workersCount",
"certificate",
"privateKey"
],
"Order": [
"name",
"hostname",
"port",
"certificate",
"privateKey",
"caCert",
"clientId",
"qos",
"workersCount",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - AWS IoT SiteWise
POST {{edgeUrl}}/cc/v2
AWS IoT SiteWise — Provider Schema
Provider ID: defbecfe-c7c0-455f-bfda-e4f4498fd2a0
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
region |
string | Region | Yes | - | - |
secretAccessKey |
string | Secret access key | Yes | - | - |
subscribeIntervalSeconds |
integer | Subscribe interval | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
accessKey |
string | Access key | Yes | - | - |
numberOfBatchMessagesToPublish |
integer | Number of batch messages | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "defbecfe-c7c0-455f-bfda-e4f4498fd2a0"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-sitewise.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "aws.sitewise.name.label",
"ToolTip": "User defined name of connector instance",
"ToolTipCode": "aws.sitewise.name.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "region",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Region",
"LabelCode": "aws.sitewise.regionName.label",
"ToolTip": "AWS region that hosts the target SiteWise resources.",
"ToolTipCode": "aws.sitewise.regionName.tooltip",
"Example": "us-west-2",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "secretAccessKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Secret access key",
"LabelCode": "aws.sitewise.secretAccessKey.label",
"ToolTip": "Secret access key paired with the access key ID",
"ToolTipCode": "aws.sitewise.secretAccessKey.tooltip",
"Example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "subscribeIntervalSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe interval",
"LabelCode": "aws.sitewise.subscribeIntervalSeconds.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "aws.sitewise.subscribeIntervalSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "accessKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Access key",
"LabelCode": "aws.sitewise.accessKey.label",
"ToolTip": "AWS access key ID of an IAM identity with permission to write to SiteWise",
"ToolTipCode": "aws.sitewise.accessKey.tooltip",
"Example": "AKIAIOSFODNN7EXAMPLE",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "numberOfBatchMessagesToPublish",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 10,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Number of batch messages",
"LabelCode": "aws.sitewise.numberOfBatchMessagesToPublish.label",
"ToolTip": "Messages accumulated before one batch publish to SiteWise",
"ToolTipCode": "aws.sitewise.numberOfBatchMessagesToPublish.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"region",
"accessKey",
"secretAccessKey"
],
"Order": [
"name",
"region",
"accessKey",
"secretAccessKey",
"subscribeIntervalSeconds",
"numberOfBatchMessagesToPublish",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - AWS IoT SiteWise (Gen 1)
POST {{edgeUrl}}/cc/v2
AWS IoT SiteWise (Gen 1) — Provider Schema
Provider ID: 493124c6-c9c0-4583-a10f-c100fbfd9f42
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
region |
string | Region | Yes | - | - |
secretAccessKey |
string | Secret access key | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
accessKey |
string | Access key | Yes | - | - |
numberOfBatchMessagesToPublish |
integer | Number of batch messages | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
subscribeIntervalSeconds |
integer | Subscribe interval | No | 1 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "493124c6-c9c0-4583-a10f-c100fbfd9f42"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-sitewise.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "aws.sitewise.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "region",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Region",
"LabelCode": "aws.sitewise.regionName.label",
"ToolTip": "AWS region where your IoT SiteWise service is deployed (e.g. us-west-2, eu-west-1).",
"ToolTipCode": "aws.sitewise.regionName.tooltip",
"Example": "us-west-2",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "secretAccessKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Secret access key",
"LabelCode": "aws.sitewise.secretAccessKey.label",
"ToolTip": "AWS IAM secret access key corresponding to the Access Key ID.",
"ToolTipCode": "aws.sitewise.secretAccessKey.tooltip",
"Example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "accessKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Access key",
"LabelCode": "aws.sitewise.accessKey.label",
"ToolTip": "AWS IAM access key ID for authenticating API calls to IoT SiteWise.",
"ToolTipCode": "aws.sitewise.accessKey.tooltip",
"Example": "AKIAIOSFODNN7EXAMPLE",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "numberOfBatchMessagesToPublish",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 10,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Number of batch messages",
"LabelCode": "aws.sitewise.numberOfBatchMessagesToPublish.label",
"ToolTip": "The number of batch messages to publish",
"ToolTipCode": "aws.sitewise.numberOfBatchMessagesToPublish.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "subscribeIntervalSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe interval",
"LabelCode": "aws.sitewise.subscribeIntervalSeconds.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "aws.sitewise.subscribeIntervalSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"region",
"accessKey",
"secretAccessKey"
],
"Order": [
"name",
"region",
"accessKey",
"secretAccessKey",
"subscribeIntervalSeconds",
"numberOfBatchMessagesToPublish",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - AWS IoT SiteWise Edge
POST {{edgeUrl}}/cc/v2
AWS IoT SiteWise Edge — Provider Schema
Provider ID: 3de888ec-a6cf-4de8-9ed7-b87b70b98e7c
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
clientId |
string | Client ID | Yes | - | - |
port |
integer | Port | Yes | 8883 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
additionalAliasDefinition |
string | Additional Alias Definition | No | - | - |
name |
string | Instance Name | Yes | - | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
willTopic |
string | LWT topic | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
hostname |
string | Hostname | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
topic |
string | Integration Topic | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
propertyAlias |
string | Property Alias | Yes | - | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayload |
string | LWT payload | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "3de888ec-a6cf-4de8-9ed7-b87b70b98e7c"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-sitewise-.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "aws.sitewiseedge.clientId.label",
"ToolTip": "Client ID is required by MQTT server.",
"ToolTipCode": "aws.sitewiseedge.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "aws.sitewiseedge.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "aws.sitewiseedge.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload type",
"LabelCode": "aws.sitewiseedge.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "aws.sitewiseedge.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "additionalAliasDefinition",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Additional Alias Definition",
"LabelCode": "aws.sitewiseedge.additionalAliasDefinition.label",
"ToolTip": "Optional string to further define dynamic propertyAlias and Integration Topic",
"ToolTipCode": "aws.sitewiseedge.additionalAliasDefinition.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Instance Name",
"LabelCode": "aws.sitewiseedge.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "AWS IoT Sitewise Edge connector",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT QoS",
"LabelCode": "aws.sitewiseedge.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.sitewiseedge.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT topic",
"LabelCode": "aws.sitewiseedge.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "aws.sitewiseedge.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Parallel Publish Count",
"LabelCode": "aws.sitewiseedge.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "aws.sitewiseedge.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "aws.sitewiseedge.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "aws.sitewiseedge.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "aws.sitewiseedge.topic.label",
"ToolTip": "MQTT topic path used by the AWS IoT SiteWise Edge gateway for data ingestion. Must match the topic configured in the SiteWise Edge gateway settings.",
"ToolTipCode": "aws.sitewiseedge.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "propertyAlias",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Property Alias",
"LabelCode": "aws.sitewiseedge.propertyAlias.label",
"ToolTip": "AWS IoT Sitewise Asset Property Alias",
"ToolTipCode": "aws.sitewiseedge.propertyAlias.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "aws.sitewiseedge.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.sitewiseedge.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload",
"LabelCode": "aws.sitewiseedge.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "aws.sitewiseedge.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"clientId",
"propertyAlias",
"topic"
],
"Order": [
"name",
"hostname",
"port",
"clientId",
"propertyAlias",
"topic",
"additionalAliasDefinition",
"qos",
"workersCount",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Azure Event Hubs
POST {{edgeUrl}}/cc/v2
Azure Event Hubs — Provider Schema
Provider ID: ea6706b1-45b6-4401-aed9-b9a6192ee70d
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
connectionString |
string | Connection String | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
combineMessages |
boolean | Combine Messages | Yes | True |
- |
maxMessageSize |
integer | Maximum Message Size (KB) | Yes | 256 |
- |
name |
string | Name | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "ea6706b1-45b6-4401-aed9-b9a6192ee70d"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/azure-event-hub.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionString",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Connection String",
"LabelCode": "azure-event-hubs.connectionString.label",
"ToolTip": "Primary or secondary connection string copied from the Azure portal (must include Endpoint, SharedAccessKeyName, SharedAccessKey, and EntityPath)",
"ToolTipCode": "azure-event-hubs.connectionString.tooltip",
"Example": "Endpoint=sb://mynamespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=XXXXX;EntityPath=myeventhub",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "combineMessages",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Combine Messages",
"LabelCode": "azure-event-hubs.combineMessages.label",
"ToolTip": "Combine multiple messages into a single JSON array to reduce message count",
"ToolTipCode": "azure-event-hubs.combineMessages.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxMessageSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 256,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Maximum Message Size (KB)",
"LabelCode": "azure-event-hubs.maxMessageSize.label",
"ToolTip": "Maximum size of each event batch sent to Azure Event Hubs, in KB.",
"ToolTipCode": "azure-event-hubs.maxMessageSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Azure Event Hubs",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"connectionString",
"maxMessageSize",
"combineMessages"
],
"Order": [
"name",
"connectionString",
"maxMessageSize",
"combineMessages",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Azure Event Hubs (Gen 1)
POST {{edgeUrl}}/cc/v2
Azure Event Hubs (Gen 1) — Provider Schema
Provider ID: e37d3ef0-888c-480c-ad85-14e98c8162cb
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
combineMessages |
boolean | Combine messages | Yes | True |
- |
connectionString |
string | Connection string | Yes | - | - |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
connectionsCount |
integer | Parallel connections count | Yes | 50 |
- |
maxMessageSize |
integer | Maximum message size | Yes | 256 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "e37d3ef0-888c-480c-ad85-14e98c8162cb"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/azure-event-hubs.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "combineMessages",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Combine messages",
"LabelCode": "azure-event-hubs.combineMessages.label",
"ToolTip": "When enabled, several messages are combined into a single event before sending, reducing the number of requests to Azure Event Hubs.",
"ToolTipCode": "azure-event-hubs.combineMessages.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionString",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": null,
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Connection string",
"LabelCode": "azure-event-hubs.connectionString.label",
"ToolTip": "Primary or secondary connection string from the Azure portal. Format: Endpoint=sb://...;SharedAccessKeyName=...;SharedAccessKey=...;EntityPath=...",
"ToolTipCode": "azure-event-hubs.connectionString.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 512,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "azure-event-hubs.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionsCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 50,
"Minimum": 1,
"Maximum": 50,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel connections count",
"LabelCode": "azure-event-hubs.connectionsCount.label",
"ToolTip": "Number of concurrent AMQP connections opened to Azure Event Hubs. Higher values increase throughput but consume more memory and sockets.",
"ToolTipCode": "azure-event-hubs.connectionsCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxMessageSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 256,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Maximum message size",
"LabelCode": "azure-event-hubs.maxMessageSize.label",
"ToolTip": "Maximum size per event batch sent to Azure Event Hubs, in KB.",
"ToolTipCode": "azure-event-hubs.maxMessageSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"connectionString",
"maxMessageSize",
"connectionsCount",
"combineMessages"
],
"Order": [
"name",
"connectionString",
"maxMessageSize",
"connectionsCount",
"combineMessages",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Azure IoT Hub
POST {{edgeUrl}}/cc/v2
Azure IoT Hub — Provider Schema
Provider ID: 916e0831-c570-496a-881f-660296747307
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
sasKey |
string | SAS Key | Yes, when connectionType is sas |
- | - |
topic |
string | Integration Topic | Yes | devices/{deviceId}/messages/events/ |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
deviceId |
string | Device ID | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
tokenTTL |
integer | Token TTL (minutes) | No | 1440 |
- |
willTopic |
string | LWT topic | No | - | - |
hostname |
string | Hostname | Yes | {IoTHub}.azure-devices.net |
- |
port |
integer | Port | Yes | 8883 |
- |
privateKey |
string | Private key | No | `` | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
willPayload |
string | LWT payload | No | - | - |
willRetained |
boolean | LWT retained | No | False |
- |
workersCount |
integer | Parallel Publish Count | No | 16 |
- |
certificate |
string | Certificate | No | `` | - |
connectionType |
string | Connection Type | Yes | sas |
sas, certificate |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "916e0831-c570-496a-881f-660296747307"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/azure-iothub-mqtt.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "sasKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "SAS Key",
"LabelCode": "azureIoT.key.label",
"ToolTip": "Primary or secondary shared access key.",
"ToolTipCode": "azureIoT.sasKey.tooltip",
"Example": "elACzLnthGKteZLCk2TF30OppwFdABZr+k8J+WBhzLo=",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"sas"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "devices/{deviceId}/messages/events/",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "azureIoT.topic.label",
"ToolTip": "Azure IoT Hub MQTT topic for device-to-cloud messages. Default format: devices/{deviceId}/messages/events/.",
"ToolTipCode": "azureIoT.topic.tooltip",
"Example": "devices/loopedge-000c29dedd9e/messages/events/",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload type",
"LabelCode": "azureIoT.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "azureIoT.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device ID",
"LabelCode": "azureIoT.deviceId.label",
"ToolTip": "ID of the device as shown in your Azure IoT account.",
"ToolTipCode": "azureIoT.deviceId.tooltip",
"Example": "loopedge-000c29dedd9e",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tokenTTL",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1440,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Token TTL (minutes)",
"LabelCode": "azureIoT.tokenTTL.label",
"ToolTip": "The token expiry time in minutes",
"ToolTipCode": "azureIoT.tokenTTL.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"sas"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT topic",
"LabelCode": "azureIoT.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "azureIoT.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "{IoTHub}.azure-devices.net",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "azureIoT.hostname.label",
"ToolTip": "DNS name of MQTT host. It can be found in \"Overview\" tab of your Azure IoT hub.",
"ToolTipCode": "azureIoT.hostname.tooltip",
"Example": "loopedge.azure-devices.net",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "azureIoT.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "azureIoT.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "azureIoT.privateKey.label",
"ToolTip": "Private key for the device certificate, in PEM format. Must match the certificate provided above.",
"ToolTipCode": "azureIoT.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"certificate"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT QoS",
"LabelCode": "azureIoT.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "azureIoT.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload",
"LabelCode": "azureIoT.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "azureIoT.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT retained",
"LabelCode": "azureIoT.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and immediately delivers it to any new subscriber on that topic.",
"ToolTipCode": "azureIoT.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 16,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Parallel Publish Count",
"LabelCode": "azureIoT.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "azureIoT.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "azureIoT.certificate.label",
"ToolTip": "PEM certificate used to authenticate the device when Connection Type is set to certificate.",
"ToolTipCode": "azureIoT.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"certificate"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sas",
"Minimum": null,
"Maximum": null,
"Enum": [
"sas",
"certificate"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "azureIoT.connectionType.label",
"ToolTip": "Authentication method: SAS Key or Device Certificate",
"ToolTipCode": "azureIoT.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "azureIoT.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Azure IoT Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"deviceId",
"connectionType",
"topic"
],
"Order": [
"name",
"connectionType",
"hostname",
"port",
"deviceId",
"certificate",
"privateKey",
"sasKey",
"topic",
"workersCount",
"tokenTTL",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Cognite
POST {{edgeUrl}}/cc/v2
Cognite — Provider Schema
Provider ID: 468fcd36-4a73-43a6-b3a5-d1df493d6422
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
name |
string | Name | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
projectID |
string | Project ID | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
scope |
string | Scope | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
subscribeIntervalSeconds |
integer | Subscribe interval | No | 1 |
- |
tenantID |
string | Tenant ID | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
clientID |
string | Client ID | Yes | - | - |
clientSecret |
string | Client Secret | Yes | - | - |
cluster |
string | Cluster | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "468fcd36-4a73-43a6-b3a5-d1df493d6422"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/cognite.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "cognite.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "projectID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Project ID",
"LabelCode": "cognite.projectID.label",
"ToolTip": "Unique identifier of the Cognite project that data is written to.",
"ToolTipCode": "cognite.projectID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "scope",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Scope",
"LabelCode": "cognite.scope.label",
"ToolTip": "Access scope granted to the application when authenticating to Cognite.",
"ToolTipCode": "cognite.scope.tooltip",
"Example": "https://az-eastus-9.cognitedata.com/.default",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "subscribeIntervalSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe interval",
"LabelCode": "cognite.subscribeIntervalSeconds.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "cognite.subscribeIntervalSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tenantID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Tenant ID",
"LabelCode": "cognite.tenantID.label",
"ToolTip": "Microsoft Azure Tenant ID",
"ToolTipCode": "cognite.tenantID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "cognite.clientID.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Secret",
"LabelCode": "cognite.clientSecret.label",
"ToolTip": "Client secret credential paired with the Client ID.",
"ToolTipCode": "cognite.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "cluster",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Cluster",
"LabelCode": "cognite.cluster.label",
"ToolTip": "Cognite cluster that hosts the project's resources.",
"ToolTipCode": "cognite.cluster.tooltip",
"Example": "az-eastus-9",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"projectID",
"tenantID",
"clientID",
"clientSecret",
"cluster",
"scope"
],
"Order": [
"name",
"projectID",
"tenantID",
"clientID",
"clientSecret",
"cluster",
"scope",
"subscribeIntervalSeconds",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Cognite Connector (Gen 1)
POST {{edgeUrl}}/cc/v2
Cognite Connector (Gen 1) — Provider Schema
Provider ID: aa838ac1-a31e-4166-b9c9-aeb7973bd122
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
clientID |
string | Client ID | Yes | - | - |
cluster |
string | Cluster | Yes | - | - |
name |
string | Name | Yes | - | - |
projectID |
string | Project ID | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
scope |
string | Scope | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
clientSecret |
string | Client Secret | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
subscribeIntervalSeconds |
integer | Subscribe interval | No | 1 |
- |
tenantID |
string | Tenant ID | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "aa838ac1-a31e-4166-b9c9-aeb7973bd122"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/cognite.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "clientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "cognite.clientID.label",
"ToolTip": "OAuth2 client ID registered in your identity provider for authenticating API calls to CDF.",
"ToolTipCode": "cognite.clientID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "cluster",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Cluster",
"LabelCode": "cognite.cluster.label",
"ToolTip": "Cognite cluster hosting your CDF project.",
"ToolTipCode": "cognite.cluster.tooltip",
"Example": "az-eastus-9",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "cognite.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "projectID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Project ID",
"LabelCode": "cognite.projectID.label",
"ToolTip": "Cognite Data Fusion (CDF) project identifier. Found in the CDF portal under Project Settings.",
"ToolTipCode": "cognite.projectID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "scope",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Scope",
"LabelCode": "cognite.scope.label",
"ToolTip": "OAuth2 scope granting access to the CDF API.",
"ToolTipCode": "cognite.scope.tooltip",
"Example": "https://az-eastus-9.cognitedata.com/.default",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Secret",
"LabelCode": "cognite.clientSecret.label",
"ToolTip": "OAuth2 client secret paired with the Client ID. Authorizes token requests to the identity provider.",
"ToolTipCode": "cognite.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "subscribeIntervalSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe interval",
"LabelCode": "cognite.subscribeIntervalSeconds.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "cognite.subscribeIntervalSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tenantID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Tenant ID",
"LabelCode": "cognite.tenantID.label",
"ToolTip": "Microsoft Azure Tenant ID",
"ToolTipCode": "cognite.tenantID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"projectID",
"tenantID",
"clientID",
"clientSecret",
"cluster",
"scope"
],
"Order": [
"name",
"projectID",
"tenantID",
"clientID",
"clientSecret",
"cluster",
"scope",
"subscribeIntervalSeconds",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Databricks Zerobus Ingest
POST {{edgeUrl}}/cc/v2
Databricks Zerobus Ingest — Provider Schema
Provider ID: 0fb51adf-9e8c-49a7-80ac-1f232159a457
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
clientSecret |
string | Client Secret | Yes | - | - |
flushIntervalMs |
integer | Flush Interval (ms) | No | 250 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
recordType |
string | Record Type | Yes | JSON |
JSON |
asyncPublishChannelBuffer |
integer | Async Publish Channel Buffer | No | 10000 |
- |
flushAfterRecords |
integer | Flush After Records | No | 10000 |
- |
proxyType |
string | Proxy Type | No | NONE |
NONE, HTTPS_PROXY, GRPC_PROXY |
proxyValue |
string | Proxy URL | Yes, when proxyType is HTTPS_PROXY / GRPC_PROXY |
- | - |
zerobusServerUrl |
string | Zerobus Server URL | Yes | - | - |
defaultTable |
string | Default Table | Yes | - | - |
streamPausedMaxWaitTimeMs |
integer | Stream Paused Max Wait Time (ms) | No | 0 |
- |
schema |
string | Schema | Yes | - | - |
serverLackOfAckTimeoutMs |
integer | Server Lack of Ack Timeout (ms) | No | 300000 |
- |
streamCloseTimeoutMs |
integer | Stream Close Timeout (ms) | No | 10000 |
- |
recoveryRetries |
integer | Recovery Retries | No | 10 |
- |
connectionCheckingIntervalMs |
integer | Connection Checking Interval (ms) | No | 15000 |
- |
noProxy |
string | No Proxy | No | - | - |
recoveryBackoffMs |
integer | Recovery Backoff (ms) | No | 1000 |
- |
workspaceUrl |
string | Workspace URL | Yes | - | - |
localNatsConnectionCount |
integer | Local NATS Connections | No | 1 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
recovery |
boolean | Recovery | No | True |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
catalog |
string | Catalog | Yes | - | - |
clientId |
string | Client ID | Yes | - | - |
flushTimeoutMs |
integer | Flush Timeout (ms) | No | 300000 |
- |
maxInflightRequests |
integer | Max Inflight Requests | No | 500000 |
- |
name |
string | Name | Yes | - | - |
recoveryTimeoutMs |
integer | Recovery Timeout (ms) | No | 30000 |
- |
asyncPublishStreamCount |
integer | Async Publish Stream Count | No | 10 |
- |
localNatsNoEcho |
boolean | Local Nats No Echo | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "0fb51adf-9e8c-49a7-80ac-1f232159a457"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/databricks-zerobus-ingest.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "clientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Secret",
"LabelCode": "databricksZerobus.clientSecret.label",
"ToolTip": "OAuth client secret to authenticate with Databricks",
"ToolTipCode": "databricksZerobus.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "flushIntervalMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 250,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Flush Interval (ms)",
"LabelCode": "databricksZerobus.flushIntervalMs.label",
"ToolTip": "Maximum time in milliseconds between flush cycles regardless of record count. 0 disables ticker-based flushing",
"ToolTipCode": "databricksZerobus.flushIntervalMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "recordType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "JSON",
"Minimum": null,
"Maximum": null,
"Enum": [
"JSON"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Record Type",
"LabelCode": "databricksZerobus.recordType.label",
"ToolTip": "Data record format: JSON",
"ToolTipCode": "databricksZerobus.recordType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "asyncPublishChannelBuffer",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Async Publish Channel Buffer",
"LabelCode": "databricksZerobus.asyncPublishChannelBuffer.label",
"ToolTip": "Per-stream inbound channel capacity in number of payloads. Total buffered payloads = this value \u00d7 asyncPublishStreamCount. Reduce on memory-constrained deployments.",
"ToolTipCode": "databricksZerobus.asyncPublishChannelBuffer.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "flushAfterRecords",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Flush After Records",
"LabelCode": "databricksZerobus.flushAfterRecords.label",
"ToolTip": "Number of records sent since the last flush before forcing a stream.Flush() ACK drain",
"ToolTipCode": "databricksZerobus.flushAfterRecords.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "proxyType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "NONE",
"Minimum": null,
"Maximum": null,
"Enum": [
"NONE",
"HTTPS_PROXY",
"GRPC_PROXY"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Proxy Type",
"LabelCode": "databricksZerobus.proxyType.label",
"ToolTip": "Proxy protocol for outbound connections: NONE disables proxy, HTTPS_PROXY establishes a TLS tunnel via HTTP CONNECT, GRPC_PROXY routes gRPC traffic through the proxy",
"ToolTipCode": "databricksZerobus.proxyType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "proxyValue",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Proxy URL",
"LabelCode": "databricksZerobus.proxyValue.label",
"ToolTip": "Address of the proxy server to route outbound connections through. Used only when Proxy Type is not NONE.",
"ToolTipCode": "databricksZerobus.proxyValue.tooltip",
"Example": "http://my-proxy:8080",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "proxyType",
"FieldValues": [
"HTTPS_PROXY",
"GRPC_PROXY"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "zerobusServerUrl",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Zerobus Server URL",
"LabelCode": "databricksZerobus.zerobusServerUrl.label",
"ToolTip": "Databricks Zerobus Server URL. AWS format: <workspaceid>.zerobus.<region>.cloud.databricks.com, Azure format: <workspaceid>.zerobus.<region>.azuredatabricks.net",
"ToolTipCode": "databricksZerobus.zerobusServerUrl.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "defaultTable",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Default Table",
"LabelCode": "databricksZerobus.defaultTable.label",
"ToolTip": "Databricks table data is ingested into. Must exist in the schema unless \"Create Table\" is enabled.",
"ToolTipCode": "databricksZerobus.defaultTable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "streamPausedMaxWaitTimeMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Stream Paused Max Wait Time (ms)",
"LabelCode": "databricksZerobus.streamPausedMaxWaitTimeMs.label",
"ToolTip": "Maximum wait time in milliseconds when the stream is paused. 0 disables SDK pausing",
"ToolTipCode": "databricksZerobus.streamPausedMaxWaitTimeMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 16,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "azureIoT.workersCount.label",
"ToolTip": "Number of messages published simultaneously.",
"ToolTipCode": "azureIoT.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": true,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create Table",
"LabelCode": "databricksZerobus.createTable.label",
"ToolTip": "Create the target table automatically when it does not already exist. Requires permission to create tables.",
"ToolTipCode": "databricksZerobus.createTable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "databricksZerobus.schema.label",
"ToolTip": "Schema (database) within the catalog that contains the target tables.",
"ToolTipCode": "databricksZerobus.schema.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "serverLackOfAckTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 300000,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Server Lack of Ack Timeout (ms)",
"LabelCode": "databricksZerobus.serverLackOfAckTimeoutMs.label",
"ToolTip": "Time in milliseconds before the SDK assumes the Databricks server has dropped the connection",
"ToolTipCode": "databricksZerobus.serverLackOfAckTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "streamCloseTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Stream Close Timeout (ms)",
"LabelCode": "databricksZerobus.streamCloseTimeoutMs.label",
"ToolTip": "Maximum time in milliseconds allowed for stream.Close() during shutdown before the connection is abandoned",
"ToolTipCode": "databricksZerobus.streamCloseTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "recoveryRetries",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Recovery Retries",
"LabelCode": "databricksZerobus.recoveryRetries.label",
"ToolTip": "Maximum attempts to reconnect or retry a failed HTTP ingest request",
"ToolTipCode": "databricksZerobus.recoveryRetries.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionCheckingIntervalMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 15000,
"Minimum": 1000,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Checking Interval (ms)",
"LabelCode": "databricksZerobus.connectionCheckingIntervalMs.label",
"ToolTip": "Interval in milliseconds between periodic health checks. Each check performs a CreateStream+Close round-trip against the default table to verify credentials and reachability. Lower values detect credential revocation faster but add OAuth + gRPC overhead per probe.",
"ToolTipCode": "databricksZerobus.connectionCheckingIntervalMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "noProxy",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "No Proxy",
"LabelCode": "databricksZerobus.noProxy.label",
"ToolTip": "Comma-separated list of hostnames or IP addresses that bypass the proxy (e.g. localhost,127.0.0.1)",
"ToolTipCode": "databricksZerobus.noProxy.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "recoveryBackoffMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Recovery Backoff (ms)",
"LabelCode": "databricksZerobus.recoveryBackoffMs.label",
"ToolTip": "Delay in milliseconds between recovery attempts",
"ToolTipCode": "databricksZerobus.recoveryBackoffMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workspaceUrl",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Workspace URL",
"LabelCode": "databricksZerobus.workspaceUrl.label",
"ToolTip": "URL of your Databricks workspace, as shown in the browser address bar when signed in.",
"ToolTipCode": "databricksZerobus.workspaceUrl.tooltip",
"Example": "https://abcd-teste2testspcse2.cloud.databricks.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "localNatsConnectionCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 10,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Local NATS Connections",
"LabelCode": "databricksZerobus.localNatsConnectionCount.label",
"ToolTip": "Number of parallel NATS connections used to consume incoming messages",
"ToolTipCode": "databricksZerobus.localNatsConnectionCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "recovery",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Recovery",
"LabelCode": "databricksZerobus.recovery.label",
"ToolTip": "Enables the SDK's internal auto-recovery mechanism for transient failures",
"ToolTipCode": "databricksZerobus.recovery.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "catalog",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Catalog",
"LabelCode": "databricksZerobus.catalog.label",
"ToolTip": "Unity Catalog name in Databricks that contains the target schema and tables.",
"ToolTipCode": "databricksZerobus.catalog.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "databricksZerobus.clientId.label",
"ToolTip": "OAuth client ID to authenticate with Databricks",
"ToolTipCode": "databricksZerobus.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "flushTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 300000,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Flush Timeout (ms)",
"LabelCode": "databricksZerobus.flushTimeoutMs.label",
"ToolTip": "Maximum wait time in milliseconds when forcing a stream flush",
"ToolTipCode": "databricksZerobus.flushTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxInflightRequests",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500000,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max Inflight Requests",
"LabelCode": "databricksZerobus.maxInflightRequests.label",
"ToolTip": "Maximum number of unacknowledged asynchronous requests pending in the SDK",
"ToolTipCode": "databricksZerobus.maxInflightRequests.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "databricksZerobus.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "recoveryTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Recovery Timeout (ms)",
"LabelCode": "databricksZerobus.recoveryTimeoutMs.label",
"ToolTip": "Absolute time limit in milliseconds for a single recovery cycle",
"ToolTipCode": "databricksZerobus.recoveryTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "asyncPublishStreamCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Async Publish Stream Count",
"LabelCode": "databricksZerobus.asyncPublishStreamCount.label",
"ToolTip": "Number of pre-created Databricks streams in the pool; workers fan-out to these in round-robin",
"ToolTipCode": "databricksZerobus.asyncPublishStreamCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "localNatsNoEcho",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Local Nats No Echo",
"LabelCode": "databricksZerobus.localNatsNoEcho.label",
"ToolTip": "When enabled, this connection does not receive messages it published itself.",
"ToolTipCode": "databricksZerobus.localNatsNoEcho.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"workspaceUrl",
"zerobusServerUrl",
"catalog",
"schema",
"clientId",
"clientSecret",
"defaultTable",
"recordType"
],
"Order": [
"name",
"workspaceUrl",
"zerobusServerUrl",
"catalog",
"schema",
"clientId",
"clientSecret",
"defaultTable",
"createTable",
"recordType",
"localNatsConnectionCount",
"localNatsNoEcho",
"asyncPublishStreamCount",
"asyncPublishChannelBuffer",
"flushAfterRecords",
"flushIntervalMs",
"maxInflightRequests",
"streamCloseTimeoutMs",
"connectionCheckingIntervalMs",
"recovery",
"recoveryRetries",
"recoveryBackoffMs",
"recoveryTimeoutMs",
"serverLackOfAckTimeoutMs",
"flushTimeoutMs",
"streamPausedMaxWaitTimeMs",
"proxyType",
"proxyValue",
"noProxy",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - Databricks SQL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - Databricks SQL (Gen 1) — Provider Schema
Provider ID: 133c003c-2310-472d-95fe-991b74049311
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
table |
string | Table | Yes | - | - |
connString |
string | DSN Connection string | Yes | - | - |
mapping |
object | Mapping | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
createTable |
boolean | Create table | Yes | False |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "133c003c-2310-472d-95fe-991b74049311"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/databricks.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "databricks.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "databricks.table.label",
"ToolTip": "Target Databricks table to write data into. Must exist unless \"Create Table\" is enabled. Use catalog.schema.table format for Unity Catalog.",
"ToolTipCode": "databricks.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connString",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": null,
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "DSN Connection string",
"LabelCode": "databricks.connString.label",
"ToolTip": "Databricks DSN connection string. For personal access token auth use token:<token>@<host>:<port>/<http-path>.",
"ToolTipCode": "databricks.connString.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "databricks.mapping.label",
"ToolTip": "Maps incoming message field names to Databricks column names. Leave empty to use source field names as-is.",
"ToolTipCode": "databricks.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "databricks.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "databricks.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "databricks.commit_timeout.label",
"ToolTip": "Bulk insert commit timeout (ms)",
"ToolTipCode": "databricks.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "databricks.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "databricks.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"connString",
"table",
"createTable"
],
"Order": [
"name",
"connString",
"table",
"mapping",
"createTable",
"bulkSize",
"commitTimeout",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - InfluxDB v1.7.x SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - InfluxDB v1.7.x SSL (Gen 1) — Provider Schema
Provider ID: f9fda829-c2e0-47a0-83bc-7a20f3ff897a
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
address |
string | InfluxDB address | Yes | - | - |
database |
string | InfluxDB database name | Yes | - | - |
name |
string | Name | Yes | - | - |
certificate |
string | Certificate | No | `` | - |
privateKey |
string | Private key | No | `` | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
batchCommitTimeSec |
integer | Insert batch commit time | No | 5 |
- |
batchSize |
integer | Insert batch size | No | 500 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
caCert |
string | CA Certificate | No | `` | - |
password |
string | Password | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "f9fda829-c2e0-47a0-83bc-7a20f3ff897a"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/influxdb-ssl.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "address",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB address",
"LabelCode": "influxdb.address.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "http://localhost:8086",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB database name",
"LabelCode": "influxdb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "influxdb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "InfluxDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "influxdb.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with InfluxDB. Paste PEM-encoded certificate here.",
"ToolTipCode": "influxdb.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "influxdb.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "influxdb.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchCommitTimeSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 120,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch commit time",
"LabelCode": "influxdb.batchCommitTimeSec.label",
"ToolTip": "Maximum time in seconds to wait before flushing a partially-filled batch. Ensures data is written even during low-traffic periods.",
"ToolTipCode": "influxdb.batchCommitTimeSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch size",
"LabelCode": "influxdb.batchSize.label",
"ToolTip": "Number of data points buffered before a batch write is sent to InfluxDB. Higher values reduce write frequency but increase memory use.",
"ToolTipCode": "influxdb.batchSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "influxdb.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "influxdb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "influxdb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "influxdb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"address",
"database"
],
"Order": [
"name",
"address",
"database",
"username",
"password",
"caCert",
"certificate",
"privateKey",
"batchSize",
"batchCommitTimeSec",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - InfluxDB v1.7.x TCP (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - InfluxDB v1.7.x TCP (Gen 1) — Provider Schema
Provider ID: a2ead4a5-d7de-41b4-a69b-76800fe6b978
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
batchCommitTimeSec |
integer | Insert batch commit time | No | 5 |
- |
batchSize |
integer | Insert batch size | No | 500 |
- |
database |
string | InfluxDB database name | Yes | - | - |
username |
string | Username | No | - | - |
address |
string | InfluxDB address | Yes | - | - |
name |
string | Name | Yes | - | - |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "a2ead4a5-d7de-41b4-a69b-76800fe6b978"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/influxdb-tcp.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchCommitTimeSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 120,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch commit time",
"LabelCode": "influxdb.batchCommitTimeSec.label",
"ToolTip": "Maximum time in seconds to wait before flushing a partially-filled batch. Ensures data is written even during low-traffic periods.",
"ToolTipCode": "influxdb.batchCommitTimeSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch size",
"LabelCode": "influxdb.batchSize.label",
"ToolTip": "Number of data points buffered before a batch write is sent to InfluxDB. Higher values reduce write frequency but increase memory use.",
"ToolTipCode": "influxdb.batchSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB database name",
"LabelCode": "influxdb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "influxdb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "address",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB address",
"LabelCode": "influxdb.address.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "http://localhost:8086",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "influxdb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "InfluxDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "influxdb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"address",
"database"
],
"Order": [
"name",
"address",
"database",
"username",
"password",
"batchSize",
"batchCommitTimeSec",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - InfluxDB v2.x TCP (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - InfluxDB v2.x TCP (Gen 1) — Provider Schema
Provider ID: a2796f78-bab4-429a-9b18-47bcf104adb7
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
batchCommitTimeSec |
integer | Insert batch commit time | Yes | 5 |
- |
organization |
string | Organization | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
username |
string | Username | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
address |
string | InfluxDB address | Yes | - | - |
batchSize |
integer | Insert batch size | Yes | 500 |
- |
database |
string | InfluxDB bucket name | Yes | - | - |
authToken |
string | Auth token | Yes | - | - |
password |
string | Password | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "a2796f78-bab4-429a-9b18-47bcf104adb7"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/influxdb-tcp.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "batchCommitTimeSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 120,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch commit time",
"LabelCode": "influxdb.batchCommitTimeSec.label",
"ToolTip": "Maximum time in seconds to wait before flushing a partially-filled batch. Ensures data is written even during low-traffic periods.",
"ToolTipCode": "influxdb.batchCommitTimeSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "organization",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization",
"LabelCode": "influxdb.organization.label",
"ToolTip": "The InfluxDB v2 organization name or ID. Found under Organization Settings in your InfluxDB account. Required for all v2 API calls.",
"ToolTipCode": "influxdb.organization.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "influxdb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "InfluxDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "influxdb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "address",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB address",
"LabelCode": "influxdb.address.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "http://localhost:8086",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch size",
"LabelCode": "influxdb.batchSize.label",
"ToolTip": "Number of data points buffered before a batch write is sent to InfluxDB. Higher values reduce write frequency but increase memory use.",
"ToolTipCode": "influxdb.batchSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB bucket name",
"LabelCode": "influxdb.bucket.label",
"ToolTip": "Name of the InfluxDB v2 bucket (called \"database\" in v1) to write data to.",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authToken",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Auth token",
"LabelCode": "influxdb.authToken.label",
"ToolTip": "InfluxDB v2 API token with write permission for the target bucket. Generate in the InfluxDB UI under Data > API Tokens.",
"ToolTipCode": "influxdb.authToken.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "influxdb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"address",
"database",
"organization",
"authToken",
"batchSize",
"batchCommitTimeSec"
],
"Order": [
"name",
"address",
"database",
"organization",
"authToken",
"username",
"password",
"batchSize",
"batchCommitTimeSec",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - InfluxDB v2.x+ SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - InfluxDB v2.x+ SSL (Gen 1) — Provider Schema
Provider ID: 7ee2ff5b-9f5f-4299-83f8-9b3617d79ace
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
authToken |
string | Auth token | Yes | - | - |
batchCommitTimeSec |
integer | Insert batch commit time | Yes | 5 |
- |
caCert |
string | CA Certificate | No | `` | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
password |
string | Password | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
privateKey |
string | Private key | No | `` | - |
address |
string | InfluxDB address | Yes | - | - |
batchSize |
integer | Insert batch size | Yes | 500 |
- |
certificate |
string | Certificate | No | `` | - |
database |
string | InfluxDB bucket name | Yes | - | - |
name |
string | Name | Yes | - | - |
organization |
string | Organization | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "7ee2ff5b-9f5f-4299-83f8-9b3617d79ace"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/influxdb-ssl.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "authToken",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth token",
"LabelCode": "influxdb.authToken.label",
"ToolTip": "InfluxDB v2 API token with write permission for the target bucket. Generate in the InfluxDB UI under Data > API Tokens.",
"ToolTipCode": "influxdb.authToken.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchCommitTimeSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 120,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch commit time",
"LabelCode": "influxdb.batchCommitTimeSec.label",
"ToolTip": "Maximum time in seconds to wait before flushing a partially-filled batch. Ensures data is written even during low-traffic periods.",
"ToolTipCode": "influxdb.batchCommitTimeSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "influxdb.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "influxdb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "influxdb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "influxdb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "influxdb.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "influxdb.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "address",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB address",
"LabelCode": "influxdb.address.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "http://localhost:8086",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insert batch size",
"LabelCode": "influxdb.batchSize.label",
"ToolTip": "Number of data points buffered before a batch write is sent to InfluxDB. Higher values reduce write frequency but increase memory use.",
"ToolTipCode": "influxdb.batchSize.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "influxdb.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with InfluxDB. Paste PEM-encoded certificate here.",
"ToolTipCode": "influxdb.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "InfluxDB bucket name",
"LabelCode": "influxdb.bucket.label",
"ToolTip": "Name of the InfluxDB v2 bucket (called \"database\" in v1) to write data to.",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "influxdb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "InfluxDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "organization",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization",
"LabelCode": "influxdb.organization.label",
"ToolTip": "The InfluxDB v2 organization name or ID. Found under Organization Settings in your InfluxDB account. Required for all v2 API calls.",
"ToolTipCode": "influxdb.organization.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"address",
"database",
"organization",
"authToken",
"batchSize",
"batchCommitTimeSec"
],
"Order": [
"name",
"address",
"database",
"organization",
"authToken",
"username",
"password",
"caCert",
"certificate",
"privateKey",
"batchSize",
"batchCommitTimeSec",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - Microsoft SQL Server (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - Microsoft SQL Server (Gen 1) — Provider Schema
Provider ID: b49b6e76-5c8f-4ca8-93b4-901edf3b2857
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
bulkSize |
integer | Bulk insert count | No | 0 |
- |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
password |
string | Password | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
createTable |
boolean | Create table | Yes | False |
- |
port |
integer | Port | Yes | 1433 |
- |
table |
string | Table | Yes | - | - |
database |
string | Database | Yes | - | - |
mapping |
object | Mapping | No | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "b49b6e76-5c8f-4ca8-93b4-901edf3b2857"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mssql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mssql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mssql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mssql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mssql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mssql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MSSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mssql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mssql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mssql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mssql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mssql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1433,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mssql.port.label",
"ToolTip": "Port of MSSQL host.",
"ToolTipCode": "mssql.port.tooltip",
"Example": 1433,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mssql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mssql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mssql.mapping.label",
"ToolTip": "Maps incoming message field names to MSSQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "mssql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mssql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mssql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - Microsoft SQL Server SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - Microsoft SQL Server SSL (Gen 1) — Provider Schema
Provider ID: 5121e79f-4e74-4048-b5f0-3a7f1242b148
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
mapping |
object | Mapping | No | - | - |
name |
string | Name | Yes | - | - |
port |
integer | Port | Yes | 1433 |
- |
sslMode |
string | SSL Mode | Yes | true |
disable, true, false |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
hostname |
string | Hostname | Yes | - | - |
password |
string | Password | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | Yes | - | - |
caCert |
string | CA Certificate | No | `` | - |
createTable |
boolean | Create table | Yes | False |
- |
database |
string | Database | Yes | - | - |
table |
string | Table | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "5121e79f-4e74-4048-b5f0-3a7f1242b148"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mssql-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mssql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mssql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mssql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mssql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mssql.mapping.label",
"ToolTip": "Maps incoming message field names to MSSQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "mssql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mssql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MSSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1433,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mssql.port.label",
"ToolTip": "Port of MSSQL host.",
"ToolTipCode": "mssql.port.tooltip",
"Example": 1433,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "true",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"true",
"false"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "mssql.sslmode.label",
"ToolTip": "TLS behavior: true = TLS without certificate verification, false = no TLS, disable = no TLS.",
"ToolTipCode": "mssql.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mssql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mssql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mssql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mssql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mssql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mssql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "mssql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "mssql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mssql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mssql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mssql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"sslMode",
"username",
"password",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"sslMode",
"caCert",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - MongoDB (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - MongoDB (Gen 1) — Provider Schema
Provider ID: abc92242-1591-49b2-a747-439c72ecf68d
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
authMechanism |
string | Auth mechanism | No | SCRAM-SHA-1 |
SCRAM-SHA-1, MONGODB-CR, MONGO-CR, PLAIN, MONGODB-X509 |
database |
string | Database | Yes | - | - |
hostname |
string | Hostname | Yes | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
port |
integer | Port | Yes | 27017 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
authDatabase |
string | Auth database | No | admin |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
username |
string | Username | No | - | - |
collection |
string | Collection | Yes | - | - |
mapping |
object | Mapping | No | - | - |
password |
string | Password | No | - | - |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "abc92242-1591-49b2-a747-439c72ecf68d"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mongodb.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "SCRAM-SHA-1",
"Minimum": null,
"Maximum": null,
"Enum": [
"SCRAM-SHA-1",
"MONGODB-CR",
"MONGO-CR",
"PLAIN",
"MONGODB-X509"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth mechanism",
"LabelCode": "mongodb.authMechanism.label",
"ToolTip": "The mechanisms to confirm an identity and establish trust to ensure security in the driver and server before connecting",
"ToolTipCode": "mongodb.authMechanism.tooltip",
"Example": "SCRAM-SHA-1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mongodb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mongodb.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mongodb.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mongodb.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mongodb.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 27017,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mongodb.port.label",
"ToolTip": "Port of MongoDB host.",
"ToolTipCode": "mongodb.port.tooltip",
"Example": 27017,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authDatabase",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "admin",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth database",
"LabelCode": "mongodb.auth_database.label",
"ToolTip": "Database used to verify the user's credentials. Usually admin. Change only if the user account is defined in a different database.",
"ToolTipCode": "mongodb.auth_database.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mongodb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MongoDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mongodb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "collection",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Collection",
"LabelCode": "mongodb.collection.label",
"ToolTip": "MongoDB collection (equivalent to a table) where documents will be inserted. Created automatically if it does not exist.",
"ToolTipCode": "mongodb.collection.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mongodb.mapping.label",
"ToolTip": "Maps incoming message field names to MongoDB document field names. Leave empty to use source field names as-is.",
"ToolTipCode": "mongodb.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mongodb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mongodb.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mongodb.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"database",
"collection"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"authDatabase",
"authMechanism",
"database",
"collection",
"mapping",
"commitTimeout",
"maxTransactionSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - MongoDB v4+ (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - MongoDB v4+ (Gen 1) — Provider Schema
Provider ID: 363c6939-b6dc-409b-a6d6-b553692bcf2a
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
authDatabase |
string | Auth database | No | admin |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | No | - | - |
collection |
string | Collection | Yes | - | - |
database |
string | Database | Yes | - | - |
mapping |
object | Mapping | No | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 27017 |
- |
authMechanism |
string | Auth mechanism | No | SCRAM-SHA-1 |
SCRAM-SHA-1, MONGODB-CR, MONGO-CR, PLAIN, MONGODB-X509 |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
password |
string | Password | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "363c6939-b6dc-409b-a6d6-b553692bcf2a"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mongodb-v4.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authDatabase",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "admin",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth database",
"LabelCode": "mongodb.auth_database.label",
"ToolTip": "Database used to verify the user's credentials. Usually admin. Change only if the user account is defined in a different database.",
"ToolTipCode": "mongodb.auth_database.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mongodb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "collection",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Collection",
"LabelCode": "mongodb.collection.label",
"ToolTip": "MongoDB collection (equivalent to a table) where documents will be inserted. Created automatically if it does not exist.",
"ToolTipCode": "mongodb.collection.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mongodb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mongodb.mapping.label",
"ToolTip": "Maps incoming message field names to MongoDB document field names. Leave empty to use source field names as-is.",
"ToolTipCode": "mongodb.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mongodb.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mongodb.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 27017,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mongodb.port.label",
"ToolTip": "Port of MongoDB host.",
"ToolTipCode": "mongodb.port.tooltip",
"Example": 27017,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "SCRAM-SHA-1",
"Minimum": null,
"Maximum": null,
"Enum": [
"SCRAM-SHA-1",
"MONGODB-CR",
"MONGO-CR",
"PLAIN",
"MONGODB-X509"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth mechanism",
"LabelCode": "mongodb.authMechanism.label",
"ToolTip": "The mechanisms to confirm an identity and establish trust to ensure security in the driver and server before connecting",
"ToolTipCode": "mongodb.authMechanism.tooltip",
"Example": "SCRAM-SHA-1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mongodb.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mongodb.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mongodb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MongoDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mongodb.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mongodb.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mongodb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"database",
"collection"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"authDatabase",
"authMechanism",
"database",
"collection",
"mapping",
"commitTimeout",
"maxTransactionSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - MySQL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - MySQL (Gen 1) — Provider Schema
Provider ID: 2dff6cc6-c383-4744-a78b-e2892ae05c49
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
password |
string | Password | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
table |
string | Table | Yes | - | - |
username |
string | Username | Yes | - | - |
port |
integer | Port | Yes | 3306 |
- |
createTable |
boolean | Create table | Yes | False |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
database |
string | Database | Yes | - | - |
hostname |
string | Hostname | Yes | - | - |
mapping |
object | Mapping | No | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "2dff6cc6-c383-4744-a78b-e2892ae05c49"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mysql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mysql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mysql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mysql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mysql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mysql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mysql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mysql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 3306,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mysql.port.label",
"ToolTip": "Port of MySql host.",
"ToolTipCode": "mysql.port.tooltip",
"Example": 3306,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mssql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mysql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MySQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mysql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mysql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mysql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mysql.mapping.label",
"ToolTip": "Maps incoming message field names to MySQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "mysql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mysql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mysql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - MySQL SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - MySQL SSL (Gen 1) — Provider Schema
Provider ID: e4aa0200-3dae-4292-b7bf-499e293c7b33
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
bulkSize |
integer | Bulk insert count | No | 0 |
- |
database |
string | Database | Yes | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
sslMode |
string | SSL Mode | No | require |
require |
port |
integer | Port | Yes | 3306 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | Yes | - | - |
caCert |
string | CA Certificate | No | `` | - |
certificate |
string | Certificate | No | `` | - |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
mapping |
object | Mapping | No | - | - |
password |
string | Password | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
table |
string | Table | Yes | - | - |
createTable |
boolean | Create table | Yes | False |
- |
hostname |
string | Hostname | Yes | - | - |
privateKey |
string | Private key | No | `` | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "e4aa0200-3dae-4292-b7bf-499e293c7b33"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mysql-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mysql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mysql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mysql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mysql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mysql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mysql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MySQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "require",
"Minimum": null,
"Maximum": null,
"Enum": [
"require"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "mysql.sslmode.label",
"ToolTip": "TLS mode for the MySQL connection. Only require is currently supported for SSL connections.",
"ToolTipCode": "mysql.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 3306,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mysql.port.label",
"ToolTip": "Port of MySql host.",
"ToolTipCode": "mysql.port.tooltip",
"Example": 3306,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mysql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "mysql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "mysql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "mysql.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with MySQL. Paste PEM-encoded certificate here.",
"ToolTipCode": "mysql.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mysql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "mysql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mysql.mapping.label",
"ToolTip": "Maps incoming message field names to MySQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "mysql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mysql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mysql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mysql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mysql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mysql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "mysql.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate.",
"ToolTipCode": "mysql.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - PostgreSQL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - PostgreSQL (Gen 1) — Provider Schema
Provider ID: 13e1ec1f-4774-4515-8af9-26fccd4590a8
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
password |
string | Password | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 5432 |
- |
table |
string | Table | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
createTable |
boolean | Create table | Yes | False |
- |
mapping |
object | Mapping | No | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
database |
string | Database | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "13e1ec1f-4774-4515-8af9-26fccd4590a8"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/postgresql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "postgresql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5432,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "postgresql.port.label",
"ToolTip": "Port of PostgreSQL host.",
"ToolTipCode": "postgresql.port.tooltip",
"Example": 3306,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "postgresql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "postgresql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "postgresql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "postgresql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "postgresql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "postgresql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "PostgreSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "postgresql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "postgresql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "postgresql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "postgresql.mapping.label",
"ToolTip": "Maps incoming message field names to PostgreSQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "postgresql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "postgresql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "postgresql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "postgresql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "postgresql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"password",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - PostgreSQL SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - PostgreSQL SSL (Gen 1) — Provider Schema
Provider ID: b3c894c3-f11b-4d06-b720-68a52d1f6835
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
caCert |
string | CA Certificate | No | `` | - |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
mapping |
object | Mapping | No | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
privateKey |
string | Private key | No | `` | - |
table |
string | Table | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
database |
string | Database | Yes | - | - |
sslMode |
string | SSL Mode | Yes | require |
require, verify-ca, verify-full |
username |
string | Username | No | - | - |
password |
string | Password | No | - | - |
certificate |
string | Certificate | No | `` | - |
createTable |
boolean | Create table | Yes | False |
- |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
port |
integer | Port | Yes | 5432 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "b3c894c3-f11b-4d06-b720-68a52d1f6835"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/postgresql-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "postgresql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "postgresql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "postgresql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "postgresql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "postgresql.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "postgresql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "postgresql.mapping.label",
"ToolTip": "Maps incoming message field names to PostgreSQL column names. Leave empty to use source field names as-is.",
"ToolTipCode": "postgresql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "postgresql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "postgresql.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "postgresql.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "postgresql.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "postgresql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "postgresql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "require",
"Minimum": null,
"Maximum": null,
"Enum": [
"require",
"verify-ca",
"verify-full"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "postgresql.sslmode.label",
"ToolTip": "TLS validation mode: require = encrypt but skip cert verification, verify-ca = validate the CA certificate, verify-full = also validate the server hostname.",
"ToolTipCode": "postgresql.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "postgresql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "postgresql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "postgresql.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with PostgreSQL. Paste PEM-encoded certificate here.",
"ToolTipCode": "postgresql.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "postgresql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "postgresql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "postgresql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "postgresql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "PostgreSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5432,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "postgresql.port.label",
"ToolTip": "Port of PostgreSQL host.",
"ToolTipCode": "postgresql.port.tooltip",
"Example": 3306,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"database",
"sslMode",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"sslMode",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"table",
"mapping",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - DB - Snowflake (Gen 1)
POST {{edgeUrl}}/cc/v2
DB - Snowflake (Gen 1) — Provider Schema
Provider ID: a870453f-e1bc-4c04-ba9f-b8f8224646a9
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
bulkSize |
integer | Bulk insert count | No | 0 |
- |
table |
string | Table | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
warehouse |
string | Warehouse | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | Yes | - | - |
createTable |
boolean | Create table | Yes | False |
- |
schema |
string | Schema | Yes | - | - |
accountName |
string | Account | Yes | - | - |
commitTimeout |
integer | Commit timeout | No | 1000 |
- |
database |
string | Database | Yes | - | - |
maxTransactionSize |
integer | Max transaction size | No | 100 |
- |
name |
string | Name | Yes | - | - |
password |
string | Password | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "a870453f-e1bc-4c04-ba9f-b8f8224646a9"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/snowflake.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "snowflake.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "snowflake.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mysql.table.label",
"ToolTip": "Target table to write data into. Must exist unless \"Create Table\" is enabled.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "warehouse",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Warehouse",
"LabelCode": "snowflake.warehouse.label",
"ToolTip": "Snowflake virtual warehouse used to execute data loads.",
"ToolTipCode": "snowflake.warehouse.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "snowflake.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mssql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "snowflake.schema.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "accountName",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Account",
"LabelCode": "snowflake.accountName.label",
"ToolTip": "Snowflake account identifier.",
"ToolTipCode": "snowflake.accountName.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "snowflake.commit_timeout.label",
"ToolTip": "Transaction commit timeout (ms)",
"ToolTipCode": "snowflake.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "snowflake.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "snowflake.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "snowflake.max_transaction_size.tooltip",
"Example": 100,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "snowflake.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "snowflake.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"accountName",
"username",
"password",
"database",
"schema",
"warehouse",
"table",
"createTable"
],
"Order": [
"name",
"accountName",
"username",
"password",
"database",
"schema",
"warehouse",
"table",
"createTable",
"commitTimeout",
"maxTransactionSize",
"bulkSize",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Google Cloud Pub/Sub
POST {{edgeUrl}}/cc/v2
Google Cloud Pub/Sub — Provider Schema
Provider ID: 374a1bc8-184d-48ba-9b98-52386172088f
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
ackDeadlineSec |
integer | Ack deadline (seconds) | No | 20 |
- |
clientEmail |
string | Client Email | No | - | - |
connectTimeoutSeconds |
integer | Connect timeout (seconds) | No | 5 |
- |
meta |
object | Custom Attributes | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
publishCountThreshold |
integer | Publish count threshold | No | 0 |
- |
subscriptionSetupTimeoutSeconds |
integer | Subscription setup timeout (seconds) | No | 30 |
- |
key |
string | Credentials (.json) | Yes | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
name |
string | Name | Yes | - | - |
privateKeyID |
string | Private Key ID | No | - | - |
projectId |
string | Project ID | Yes | - | - |
publishByteThreshold |
integer | Publish byte threshold | No | 0 |
- |
publishDelayThreshold |
integer | Publish delay threshold (milliseconds) | No | 0 |
- |
topic |
string | Default Topic | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "374a1bc8-184d-48ba-9b98-52386172088f"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/gcloud-pubsub.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "ackDeadlineSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 20,
"Minimum": 10,
"Maximum": 600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Ack deadline (seconds)",
"LabelCode": "gcloudpubsub.ackDeadlineSec.label",
"ToolTip": "Ack deadline applied to subscriptions created by this connector. GCP allows 10-600 seconds.",
"ToolTipCode": "gcloudpubsub.ackDeadlineSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientEmail",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client Email",
"LabelCode": "gcloudpubsub.clientEmail.label",
"ToolTip": "Optional override for the client_email field inside the credentials JSON",
"ToolTipCode": "gcloudpubsub.clientEmail.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeoutSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connect timeout (seconds)",
"LabelCode": "gcloudpubsub.connectTimeoutSeconds.label",
"ToolTip": "Timeout for establishing a new client connection to Pub/Sub",
"ToolTipCode": "gcloudpubsub.connectTimeoutSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "meta",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Custom Attributes",
"LabelCode": "gcloudpubsub.customAttributes.label",
"ToolTip": "Static attributes attached to every published message",
"ToolTipCode": "gcloudpubsub.customAttributes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "publishCountThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish count threshold",
"LabelCode": "gcloudpubsub.countThreshold.label",
"ToolTip": "Publisher batch size in message count (0 = use SDK default)",
"ToolTipCode": "gcloudpubsub.countThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "subscriptionSetupTimeoutSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 15,
"Maximum": 120,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscription setup timeout (seconds)",
"LabelCode": "gcloudpubsub.subscriptionSetupTimeoutSeconds.label",
"ToolTip": "Timeout for creating the inbound subscription on Pub/Sub",
"ToolTipCode": "gcloudpubsub.subscriptionSetupTimeoutSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "key",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Credentials (.json)",
"LabelCode": "gcloudpubsub.key.label",
"ToolTip": "Service account credentials JSON",
"ToolTipCode": "gcloudpubsub.key.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "gcloudpubsub.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKeyID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Private Key ID",
"LabelCode": "gcloudpubsub.privateKeyID.label",
"ToolTip": "Optional override for the private_key_id field inside the credentials JSON",
"ToolTipCode": "gcloudpubsub.privateKeyID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "projectId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Project ID",
"LabelCode": "gcloudpubsub.projectId.label",
"ToolTip": "The project ID of the cloud project",
"ToolTipCode": "gcloudpubsub.projectId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishByteThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish byte threshold",
"LabelCode": "gcloudpubsub.byteThreshold.label",
"ToolTip": "Publisher batch size in bytes (0 = use SDK default)",
"ToolTipCode": "gcloudpubsub.byteThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishDelayThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish delay threshold (milliseconds)",
"LabelCode": "gcloudpubsub.delayThreshold.label",
"ToolTip": "Maximum time the publisher waits before flushing a partial batch (0 = use SDK default)",
"ToolTipCode": "gcloudpubsub.delayThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Default Topic",
"LabelCode": "gcloudpubsub.topic.label",
"ToolTip": "Default Pub/Sub topic. Accepts a bare topic name or the fully-qualified path projects/{project}/topics/{topic}.",
"ToolTipCode": "gcloudpubsub.topic.tooltip",
"Example": "projects/my-project/topics/my-topic",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"key",
"projectId",
"topic",
"workersCount"
],
"Order": [
"name",
"key",
"projectId",
"privateKeyID",
"clientEmail",
"topic",
"meta",
"workersCount",
"ackDeadlineSec",
"publishByteThreshold",
"publishCountThreshold",
"publishDelayThreshold",
"connectTimeoutSeconds",
"subscriptionSetupTimeoutSeconds",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Google Cloud Pub/Sub Connector (Gen 1)
POST {{edgeUrl}}/cc/v2
Google Cloud Pub/Sub Connector (Gen 1) — Provider Schema
Provider ID: 962fa4a8-3c82-4e3a-af50-9603b179d435
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
key |
string | Credentials (.json) | Yes | - | - |
meta |
object | Custom Attributes | No | - | - |
privateKeyID |
string | Private Key ID | No | - | - |
projectId |
string | Project ID | Yes | - | - |
publishDelayThreshold |
integer | Publish delay threshold (Milliseconds) | No | 0 |
- |
clientEmail |
string | Client Email | No | - | - |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
publishByteThreshold |
integer | Publish byte threshold | No | 0 |
- |
publishCountThreshold |
integer | Publish count threshold | No | 0 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Integration Topic | Yes | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "962fa4a8-3c82-4e3a-af50-9603b179d435"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/gcloud-pubsub.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "key",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Credentials (.json)",
"LabelCode": "gcloudpubsub.key.label",
"ToolTip": "Google Cloud service account credentials in JSON format.",
"ToolTipCode": "gcloudpubsub.key.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "meta",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Custom Attributes",
"LabelCode": "gcloudpubsub.customAttributes.label",
"ToolTip": "Custom key-value metadata attached to each published Pub/Sub message. Available to subscribers via message attributes.",
"ToolTipCode": "gcloudpubsub.customAttributes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKeyID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Private Key ID",
"LabelCode": "gcloudpubsub.privateKeyID.label",
"ToolTip": "The private key ID of the cloud project",
"ToolTipCode": "gcloudpubsub.privateKeyID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "projectId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Project ID",
"LabelCode": "gcloudpubsub.projectId.label",
"ToolTip": "The project ID of the cloud project",
"ToolTipCode": "gcloudpubsub.projectId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishDelayThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish delay threshold (Milliseconds)",
"LabelCode": "gcloudpubsub.delayThreshold.label",
"ToolTip": "Publish delay threshold (0 is a default value, could be interpreted like - no limits)",
"ToolTipCode": "gcloudpubsub.delayThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientEmail",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client Email",
"LabelCode": "gcloudpubsub.clientEmail.label",
"ToolTip": "The client email of the cloud project",
"ToolTipCode": "gcloudpubsub.clientEmail.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "gcloudpubsub.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "publishByteThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish byte threshold",
"LabelCode": "gcloudpubsub.byteThreshold.label",
"ToolTip": "Total batch size in bytes that triggers a publish to Pub/Sub. Leave at 0 to use the client default.",
"ToolTipCode": "gcloudpubsub.byteThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishCountThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish count threshold",
"LabelCode": "gcloudpubsub.countThreshold.label",
"ToolTip": "Number of messages in a batch that triggers a publish to Pub/Sub. Higher values improve throughput at the cost of latency.",
"ToolTipCode": "gcloudpubsub.countThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "gcloudpubsub.topic.label",
"ToolTip": "Full Pub/Sub topic resource name in the format projects/{project-id}/topics/{topic-id}.",
"ToolTipCode": "gcloudpubsub.topic.tooltip",
"Example": "projects/project-identifier/collection/relative-name",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"key",
"projectId",
"topic",
"workersCount"
],
"Order": [
"name",
"key",
"projectId",
"privateKeyID",
"clientEmail",
"topic",
"meta",
"workersCount",
"publishByteThreshold",
"publishCountThreshold",
"publishDelayThreshold",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - InfluxDB v3
POST {{edgeUrl}}/cc/v2
InfluxDB v3 — Provider Schema
Provider ID: a55ebcc8-3ec9-4a10-8f2b-ff615d480e36
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
caCert |
string | CA Certificate | No | `` | - |
connectionType |
string | Connection Type | Yes | tcp |
tcp, ssl |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
staticTags |
object | Static Tags | No | - | - |
certificate |
string | Certificate | No | `` | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
token |
string | API Token | No | - | - |
batchIntervalMs |
integer | Batch Interval (ms) | No | 1000 |
- |
batchSize |
integer | Batch Size | No | 5000 |
- |
host |
string | Host URL | Yes | - | - |
organization |
string | Organization | No | - | - |
precision |
string | Write Precision | No | ms |
ns, us, ms, s |
privateKey |
string | Private key | No | `` | - |
database |
string | Database | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "a55ebcc8-3ec9-4a10-8f2b-ff615d480e36"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/influxdb3.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "tcp",
"Minimum": null,
"Maximum": null,
"Enum": [
"tcp",
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "",
"ToolTip": "Select TCP for plain connection or SSL for TLS-encrypted connection",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "",
"ToolTip": "",
"ToolTipCode": "",
"Example": "InfluxDB v3",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "staticTags",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Static Tags",
"LabelCode": "",
"ToolTip": "Static key-value pairs appended as tags to all data published to InfluxDB",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "",
"ToolTip": "Client certificate for mutual TLS authentication with InfluxDB. Paste the PEM-encoded certificate here.",
"ToolTipCode": "",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "API Token",
"LabelCode": "",
"ToolTip": "Authentication token with appropriate scoped permissions",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchIntervalMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 100,
"Maximum": 60000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Batch Interval (ms)",
"LabelCode": "",
"ToolTip": "Time interval between write flushes in milliseconds",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5000,
"Minimum": 1,
"Maximum": 10000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Batch Size",
"LabelCode": "",
"ToolTip": "Number of records per write batch",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "host",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Host URL",
"LabelCode": "",
"ToolTip": "InfluxDB v3 server URL",
"ToolTipCode": "",
"Example": "https://us-east-1-1.aws.cloud2.influxdata.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "organization",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization",
"LabelCode": "",
"ToolTip": "Organization name or ID. Required for InfluxDB Cloud services.",
"ToolTipCode": "",
"Example": "my-org",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "precision",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "ms",
"Minimum": null,
"Maximum": null,
"Enum": [
"ns",
"us",
"ms",
"s"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Write Precision",
"LabelCode": "",
"ToolTip": "Timestamp precision for publishing data (ns=nanoseconds, us=microseconds, ms=milliseconds, s=seconds)",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "",
"ToolTip": "Target InfluxDB v3 database name (formally Bucket in v2)",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"host",
"connectionType",
"database"
],
"Order": [
"name",
"host",
"connectionType",
"caCert",
"certificate",
"privateKey",
"organization",
"database",
"token",
"staticTags",
"precision",
"batchSize",
"batchIntervalMs",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Kafka
POST {{edgeUrl}}/cc/v2
Kafka — Provider Schema
Provider ID: f0c40ed3-b354-4188-849a-6ceeb2f3b1c1
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
topic |
string | Topic | Yes | - | - |
username |
string | Username | No | - | - |
verboseConnectionInfo |
boolean | Verbose connection info | No | False |
- |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
writeTimeoutMs |
integer | Write Timeout (ms) | No | 10000 |
- |
connIdleTimeoutMs |
integer | Connection Idle Timeout (ms) | No | 540000 |
- |
fetchMaxBytes |
integer | Fetch Max Bytes | No | 52428800 |
- |
fetchMinBytes |
integer | Fetch Min Bytes | No | 1 |
- |
maxMessageBytes |
integer | Max Message Bytes | No | 1000000 |
- |
brokers |
string | Brokers list separated by comma | Yes | - | - |
connectionType |
string | Connection Type | Yes | tcp |
tcp, ssl |
fetchMaxWaitMs |
integer | Fetch Max Wait (ms) | No | 500 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
recordDeliveryTimeoutSec |
integer | Record Delivery Timeout (s) | No | 10 |
- |
certificate |
string | Certificate | No | `` | - |
groupId |
string | Consumer Group ID | No | `` | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
requestTimeoutMs |
integer | Request Timeout (ms) | No | 30000 |
- |
producerBatchMaxBytes |
integer | Producer Batch Max Bytes | No | 1000000 |
- |
producerLingerMs |
integer | Producer Linger (ms) | No | 5 |
- |
rebalanceTimeoutMs |
integer | Rebalance Timeout (ms) | No | 60000 |
- |
retryBackoffMs |
integer | Retry Backoff (ms) | No | 100 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
disableIdempotentWrite |
boolean | Disable Idempotent Write | No | False |
- |
metadataMinRefreshMs |
integer | Metadata Min Refresh (ms) | No | 5000 |
- |
password |
string | Password | No | - | - |
produceRetries |
integer | Produce Retries | No | 2147483647 |
- |
readTimeoutMs |
integer | Read Timeout (ms) | No | 10000 |
- |
autoCreateTopic |
boolean | Auto create topic | No | False |
- |
compressionType |
string | Compression Type | No | none |
none, gzip, snappy, lz4, zstd |
dialTimeoutMs |
integer | Dial Timeout (ms) | No | 10000 |
- |
name |
string | Name | Yes | - | - |
producerTimeoutMs |
integer | Producer Timeout (ms) | No | 30000 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
requiredAcks |
string | Required Acknowledgments | No | all |
none, leader, all |
caCert |
string | CA Certificate | No | `` | - |
clientId |
string | Client ID | No | go-client |
- |
insecureSkipVerify |
boolean | Insecure Skip Verify | No | False |
- |
maxBufferedRecords |
integer | Max Buffered Records | No | 100000 |
- |
maxPartitionBytes |
integer | Max Partition Bytes | No | 1048576 |
- |
metadataMaxAgeMs |
integer | Metadata Max Age (ms) | No | 300000 |
- |
privateKey |
string | Private key | No | `` | - |
heartbeatIntervalMs |
integer | Heartbeat Interval (ms) | No | 3000 |
- |
saslMechanism |
string | SASL mechanism | Yes | SCRAM-SHA-256 |
NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 |
sessionTimeoutMs |
integer | Session Timeout (ms) | No | 10000 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "f0c40ed3-b354-4188-849a-6ceeb2f3b1c1"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/kafka.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Topic",
"LabelCode": "kafka.topic.label",
"ToolTip": "Kafka topic to publish messages to. Topic must exist on the broker unless Auto Create Topic is enabled.",
"ToolTipCode": "kafka.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "kafka.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "verboseConnectionInfo",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Verbose connection info",
"LabelCode": "kafka.verboseConnectionInfo.label",
"ToolTip": "Log detailed connection events (connect, disconnect, reconnect) to assist with troubleshooting.",
"ToolTipCode": "kafka.verboseConnectionInfo.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 100000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Write Timeout (ms)",
"LabelCode": "kafka.writeTimeoutMs.label",
"ToolTip": "Write operation timeout",
"ToolTipCode": "kafka.writeTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connIdleTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 540000,
"Minimum": 0,
"Maximum": 3600000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Idle Timeout (ms)",
"LabelCode": "kafka.connIdleTimeoutMs.label",
"ToolTip": "Maximum idle time before closing connections",
"ToolTipCode": "kafka.connIdleTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "fetchMaxBytes",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 52428800,
"Minimum": 0,
"Maximum": 104857600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Fetch Max Bytes",
"LabelCode": "kafka.fetchMaxBytes.label",
"ToolTip": "Maximum bytes to fetch in each request",
"ToolTipCode": "kafka.fetchMaxBytes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "fetchMinBytes",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 0,
"Maximum": 104857600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Fetch Min Bytes",
"LabelCode": "kafka.fetchMinBytes.label",
"ToolTip": "Minimum bytes to fetch in each request",
"ToolTipCode": "kafka.fetchMinBytes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxMessageBytes",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000000,
"Minimum": 0,
"Maximum": 104857600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max Message Bytes",
"LabelCode": "kafka.maxMessageBytes.label",
"ToolTip": "Maximum message size in bytes",
"ToolTipCode": "kafka.maxMessageBytes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "brokers",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Brokers list separated by comma",
"LabelCode": "kafka.brokers.label",
"ToolTip": "Comma-separated list of Kafka broker addresses in host:port format. Example: broker1:9092,broker2:9092",
"ToolTipCode": "kafka.brokers.tooltip",
"Example": "one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "tcp",
"Minimum": null,
"Maximum": null,
"Enum": [
"tcp",
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "generic.connectionType.label",
"ToolTip": "Choose tcp for an unencrypted connection or ssl for a TLS-encrypted connection to the Kafka broker.",
"ToolTipCode": "generic.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "fetchMaxWaitMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 0,
"Maximum": 60000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Fetch Max Wait (ms)",
"LabelCode": "kafka.fetchMaxWaitMs.label",
"ToolTip": "Maximum time to wait for fetch requests",
"ToolTipCode": "kafka.fetchMaxWaitMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "recordDeliveryTimeoutSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 0,
"Maximum": 30,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Record Delivery Timeout (s)",
"LabelCode": "kafka.recordDeliveryTimeoutSec.label",
"ToolTip": "Maximum time a record may be retried before it fails terminally. Bounds retries so undeliverable fire-and-forget messages are eventually reported as dropped instead of retried forever.",
"ToolTipCode": "kafka.recordDeliveryTimeoutSec.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "kafka.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the Kafka broker. Paste the PEM-encoded certificate here.",
"ToolTipCode": "kafka.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "groupId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Consumer Group ID",
"LabelCode": "kafka.groupId.label",
"ToolTip": "Consumer group to join when subscribing to inbound topics, so progress is committed and shared across connectors using the same id. Leave empty to read every partition without committing offsets. The session, heartbeat and rebalance timeouts below apply only when this is set.",
"ToolTipCode": "kafka.groupId.tooltip",
"Example": "loopedge-consumers",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "requestTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Request Timeout (ms)",
"LabelCode": "kafka.requestTimeoutMs.label",
"ToolTip": "Maximum time to wait for requests to complete",
"ToolTipCode": "kafka.requestTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "producerBatchMaxBytes",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000000,
"Minimum": 0,
"Maximum": 104857600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Producer Batch Max Bytes",
"LabelCode": "kafka.producerBatchMaxBytes.label",
"ToolTip": "Maximum size of producer batches in bytes",
"ToolTipCode": "kafka.producerBatchMaxBytes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "producerLingerMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 0,
"Maximum": 10000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Producer Linger (ms)",
"LabelCode": "kafka.producerLingerMs.label",
"ToolTip": "Time to wait for additional messages before sending batch",
"ToolTipCode": "kafka.producerLingerMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "rebalanceTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 60000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Rebalance Timeout (ms)",
"LabelCode": "kafka.rebalanceTimeoutMs.label",
"ToolTip": "Consumer group rebalance timeout",
"ToolTipCode": "kafka.rebalanceTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "retryBackoffMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 0,
"Maximum": 10000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Retry Backoff (ms)",
"LabelCode": "kafka.retryBackoffMs.label",
"ToolTip": "Backoff time between retry attempts",
"ToolTipCode": "kafka.retryBackoffMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "disableIdempotentWrite",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Disable Idempotent Write",
"LabelCode": "kafka.disableIdempotentWrite.label",
"ToolTip": "Disable idempotent producer writes. When disabled, duplicate messages may be produced during retries. Note: When idempotent write is enabled (unchecked), Required Acknowledgments must be set to 'all'",
"ToolTipCode": "kafka.disableIdempotentWrite.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "metadataMinRefreshMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5000,
"Minimum": 5000,
"Maximum": 60000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Metadata Min Refresh (ms)",
"LabelCode": "kafka.metadataMinRefreshMs.label",
"ToolTip": "Minimum time between metadata refreshes. Values below 5000 ms make the broker serve excessive metadata requests, so they are not accepted.",
"ToolTipCode": "kafka.metadataMinRefreshMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "kafka.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "produceRetries",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2147483647,
"Minimum": 0,
"Maximum": 2147483647,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Produce Retries",
"LabelCode": "kafka.produceRetries.label",
"ToolTip": "Maximum number of retry attempts for failed requests",
"ToolTipCode": "kafka.produceRetries.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "readTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Read Timeout (ms)",
"LabelCode": "kafka.readTimeoutMs.label",
"ToolTip": "Read operation timeout",
"ToolTipCode": "kafka.readTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "autoCreateTopic",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auto create topic",
"LabelCode": "kafka.autoCreateTopic.label",
"ToolTip": "Enable automatic topic creation when the topic is not found, this also requires to enable auto create topic config on the Kafka broker.",
"ToolTipCode": "kafka.autoCreateTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "compressionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "none",
"Minimum": null,
"Maximum": null,
"Enum": [
"none",
"gzip",
"snappy",
"lz4",
"zstd"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Compression Type",
"LabelCode": "kafka.compressionType.label",
"ToolTip": "Compression algorithm for message payloads",
"ToolTipCode": "kafka.compressionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "dialTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Dial Timeout (ms)",
"LabelCode": "kafka.dialTimeoutMs.label",
"ToolTip": "Connection establishment timeout",
"ToolTipCode": "kafka.dialTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "kafka.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Kafka",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "producerTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Producer Timeout (ms)",
"LabelCode": "kafka.producerTimeoutMs.label",
"ToolTip": "Maximum time to wait for producer response",
"ToolTipCode": "kafka.producerTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "requiredAcks",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "all",
"Minimum": null,
"Maximum": null,
"Enum": [
"none",
"leader",
"all"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Required Acknowledgments",
"LabelCode": "kafka.requiredAcks.label",
"ToolTip": "Level of acknowledgment reliability (none=0, leader=1, all=-1). Note: When idempotent write is enabled, this must be set to 'all'",
"ToolTipCode": "kafka.requiredAcks.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "kafka.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "kafka.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "go-client",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "kafka.clientId.label",
"ToolTip": "Client identifier sent to Kafka brokers",
"ToolTipCode": "kafka.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure Skip Verify",
"LabelCode": "kafka.insecureSkipVerify.label",
"ToolTip": "Insecure Skip Verify controls whether a client verifies the server's certificate chain and host name",
"ToolTipCode": "kafka.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "maxBufferedRecords",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100000,
"Minimum": 0,
"Maximum": 500000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max Buffered Records",
"LabelCode": "kafka.maxBufferedRecords.label",
"ToolTip": "Maximum number of messages buffered in memory while waiting to be sent to the broker. When the buffer is full, new messages are stored in persistent storage until the broker catches up, or dropped if persistent storage is disabled.",
"ToolTipCode": "kafka.maxBufferedRecords.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxPartitionBytes",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1048576,
"Minimum": 0,
"Maximum": 104857600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max Partition Bytes",
"LabelCode": "kafka.maxPartitionBytes.label",
"ToolTip": "Maximum bytes to fetch per partition",
"ToolTipCode": "kafka.maxPartitionBytes.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "metadataMaxAgeMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 300000,
"Minimum": 0,
"Maximum": 3600000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Metadata Max Age (ms)",
"LabelCode": "kafka.metadataMaxAgeMs.label",
"ToolTip": "Maximum age of metadata before refresh",
"ToolTipCode": "kafka.metadataMaxAgeMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "kafka.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "kafka.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "heartbeatIntervalMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 3000,
"Minimum": 0,
"Maximum": 60000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Heartbeat Interval (ms)",
"LabelCode": "kafka.heartbeatIntervalMs.label",
"ToolTip": "Consumer group heartbeat interval",
"ToolTipCode": "kafka.heartbeatIntervalMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "saslMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "SCRAM-SHA-256",
"Minimum": null,
"Maximum": null,
"Enum": [
"NONE",
"SASL_PLAINTEXT",
"SCRAM-SHA-256",
"SCRAM-SHA-512"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SASL mechanism",
"LabelCode": "kafka.sasl-mechanism.label",
"ToolTip": "Authentication mechanism: NONE for no auth, SASL_PLAINTEXT for plain credentials over an unencrypted connection, SCRAM-SHA-256 or SCRAM-SHA-512 for secure salted-hash authentication.",
"ToolTipCode": "kafka.sasl-mechanism.tooltip",
"Example": "SCRAM-SHA-256",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sessionTimeoutMs",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10000,
"Minimum": 0,
"Maximum": 300000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Session Timeout (ms)",
"LabelCode": "kafka.sessionTimeoutMs.label",
"ToolTip": "Consumer group session timeout",
"ToolTipCode": "kafka.sessionTimeoutMs.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"connectionType",
"brokers",
"saslMechanism",
"topic",
"workersCount"
],
"Order": [
"name",
"connectionType",
"brokers",
"saslMechanism",
"username",
"password",
"caCert",
"certificate",
"privateKey",
"insecureSkipVerify",
"topic",
"autoCreateTopic",
"clientId",
"groupId",
"sessionTimeoutMs",
"heartbeatIntervalMs",
"rebalanceTimeoutMs",
"dialTimeoutMs",
"requestTimeoutMs",
"connIdleTimeoutMs",
"metadataMaxAgeMs",
"metadataMinRefreshMs",
"requiredAcks",
"disableIdempotentWrite",
"producerTimeoutMs",
"producerBatchMaxBytes",
"producerLingerMs",
"maxBufferedRecords",
"compressionType",
"maxMessageBytes",
"fetchMinBytes",
"fetchMaxBytes",
"fetchMaxWaitMs",
"maxPartitionBytes",
"retryBackoffMs",
"produceRetries",
"recordDeliveryTimeoutSec",
"writeTimeoutMs",
"readTimeoutMs",
"workersCount",
"verboseConnectionInfo",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Kafka SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
Kafka SSL (Gen 1) — Provider Schema
Provider ID: d2413da3-fd32-48dd-ab66-6e62090a5f6d
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Topic | Yes | - | - |
name |
string | Name | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
caCert |
string | CA Certificate | No | `` | - |
certificate |
string | Certificate | No | `` | - |
insecureSkipVerify |
boolean | Insecure Skip Verify | Yes | False |
- |
saslMechanism |
string | SASL mechanism | Yes | SCRAM-SHA-256 |
NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 |
username |
string | Username | No | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 2000 |
- |
brokers |
string | Brokers list separated by comma | Yes | - | - |
privateKey |
string | Private key | No | `` | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "d2413da3-fd32-48dd-ab66-6e62090a5f6d"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/kafka-ssl.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "kafka.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Topic",
"LabelCode": "kafka.topic.label",
"ToolTip": "Kafka topic to publish messages to. Must exist on the broker unless auto-creation is enabled.",
"ToolTipCode": "kafka.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "kafka.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Kafka",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "kafka.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "kafka.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "kafka.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with Kafka brokers. Paste PEM-encoded certificate here.",
"ToolTipCode": "kafka.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure Skip Verify",
"LabelCode": "kafka.insecureSkipVerify.label",
"ToolTip": "When enabled, the broker's certificate chain and host name are not verified. Use only for testing, as this removes protection against man-in-the-middle attacks.",
"ToolTipCode": "kafka.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "saslMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "SCRAM-SHA-256",
"Minimum": null,
"Maximum": null,
"Enum": [
"NONE",
"SASL_PLAINTEXT",
"SCRAM-SHA-256",
"SCRAM-SHA-512"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SASL mechanism",
"LabelCode": "kafka.sasl-mechanism.label",
"ToolTip": "Authentication mechanism: NONE for no auth, SASL_PLAINTEXT for plain credentials, SCRAM-SHA-256 or SCRAM-SHA-512 for secure salted-hash authentication.",
"ToolTipCode": "kafka.sasl-mechanism.tooltip",
"Example": "SCRAM-SHA-256",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "kafka.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "kafka.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "kafka.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "brokers",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Brokers list separated by comma",
"LabelCode": "kafka.brokers.label",
"ToolTip": "Comma-separated list of Kafka broker addresses in host:port format. Example: broker1:9092,broker2:9092",
"ToolTipCode": "kafka.brokers.tooltip",
"Example": "one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "kafka.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "kafka.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"brokers",
"saslMechanism",
"insecureSkipVerify",
"topic",
"workersCount"
],
"Order": [
"name",
"brokers",
"saslMechanism",
"username",
"password",
"caCert",
"certificate",
"privateKey",
"insecureSkipVerify",
"topic",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Kafka TCP (Gen 1)
POST {{edgeUrl}}/cc/v2
Kafka TCP (Gen 1) — Provider Schema
Provider ID: 8e2f6527-519b-484c-ae51-226d67036e86
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
brokers |
string | Brokers list separated by comma | Yes | - | - |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Topic | Yes | - | - |
username |
string | Username | No | - | - |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
saslMechanism |
string | SASL mechanism | Yes | SCRAM-SHA-256 |
NONE, SASL_PLAINTEXT, SCRAM-SHA-256, SCRAM-SHA-512 |
workersCount |
integer | Parallel Publish Count | Yes | 2000 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "8e2f6527-519b-484c-ae51-226d67036e86"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/kafka-tcp.json",
"Schema": "http://json-schema.org/schema#",
"Type": "object",
"Properties": [
{
"Key": "brokers",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Brokers list separated by comma",
"LabelCode": "kafka.brokers.label",
"ToolTip": "Comma-separated list of Kafka broker addresses in host:port format. Example: broker1:9092,broker2:9092",
"ToolTipCode": "kafka.brokers.tooltip",
"Example": "one.litmus.pro:9094,two.litmus.pro:9094,three.litmus.pro:9094",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 1024,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "kafka.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Kafka",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Topic",
"LabelCode": "kafka.topic.label",
"ToolTip": "Kafka topic to publish messages to. Must exist on the broker unless auto-creation is enabled.",
"ToolTipCode": "kafka.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "kafka.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "kafka.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "saslMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "SCRAM-SHA-256",
"Minimum": null,
"Maximum": null,
"Enum": [
"NONE",
"SASL_PLAINTEXT",
"SCRAM-SHA-256",
"SCRAM-SHA-512"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SASL mechanism",
"LabelCode": "kafka.sasl-mechanism.label",
"ToolTip": "Authentication mechanism: NONE for no auth, SASL_PLAINTEXT for plain credentials, SCRAM-SHA-256 or SCRAM-SHA-512 for secure salted-hash authentication.",
"ToolTipCode": "kafka.sasl-mechanism.tooltip",
"Example": "SCRAM-SHA-256",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "kafka.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "kafka.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"brokers",
"saslMechanism",
"topic",
"workersCount"
],
"Order": [
"name",
"brokers",
"saslMechanism",
"username",
"password",
"topic",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Litmus Unify
POST {{edgeUrl}}/cc/v2
Litmus Unify — Provider Schema
Provider ID: 7c1f3a92-5b8e-4d6a-9f27-0a4c8e35b1d3
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
token |
string | Litmus Unify Token | No | `` | - |
UnifyClientID |
string | Unify Client ID | No | `` | - |
insecureSkipVerify |
boolean | Skip Certificate Verification | No | False |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
port |
integer | Port | No | 0 |
- |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
connectionType |
string | Connection Type | No | mqtt |
mqtt, mqtts, ws, wss |
path |
string | WebSocket Path | No | `` | - |
name |
string | Name | Yes | - | - |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
UnifyHierarchy |
string | Unify Hierarchy | No | `` | - |
caCert |
string | CA Certificate | No | `` | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "7c1f3a92-5b8e-4d6a-9f27-0a4c8e35b1d3"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/litmus-unify.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Litmus Unify Token",
"LabelCode": "litmusunify.token.label",
"ToolTip": "Litmus Unify token, exchanged once on save for the broker coordinates; a new one re-registers.",
"ToolTipCode": "litmusunify.token.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "UnifyClientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": false,
"Advanced": null,
"Label": "Unify Client ID",
"LabelCode": "litmusunify.UnifyClientID.label",
"ToolTip": "Identifier Litmus Unify assigned to this edge at registration. Filled in automatically.",
"ToolTipCode": "litmusunify.UnifyClientID.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Skip Certificate Verification",
"LabelCode": "litmusunify.insecureSkipVerify.label",
"ToolTip": "Skips verifying the broker's certificate. For self-signed test brokers only.",
"ToolTipCode": "litmusunify.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "litmusunify.port.label",
"ToolTip": "Broker port for the selected transport. Set by registration; 0 keeps it, or change it as needed.",
"ToolTipCode": "litmusunify.port.tooltip",
"Example": 8883,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "litmusunify.connectTimeout.label",
"ToolTip": "Seconds a connection attempt may take; over ws and wss this also bounds the WebSocket handshake.",
"ToolTipCode": "litmusunify.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "mqtt",
"Minimum": null,
"Maximum": null,
"Enum": [
"mqtt",
"mqtts",
"ws",
"wss"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "litmusunify.connectionType.label",
"ToolTip": "Broker transport: mqtt/ws are plaintext, mqtts/wss use TLS. Set by registration, editable after.",
"ToolTipCode": "litmusunify.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "path",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "WebSocket Path",
"LabelCode": "litmusunify.path.label",
"ToolTip": "WebSocket path the broker serves MQTT on, e.g. /mqtt. Must start with /. Used by ws and wss only.",
"ToolTipCode": "litmusunify.path.tooltip",
"Example": "/mqtt",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ws",
"wss"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "jsonConfig",
"Value": {
"Type": "string",
"Hidden": true,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": true,
"Advanced": null,
"Label": "Resolved Broker Configuration",
"LabelCode": "litmusunify.jsonConfig.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "litmusunify.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Litmus Unify",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "litmusunify.publishWaitTimeout.label",
"ToolTip": "Seconds a single publish may take before it is given up on.",
"ToolTipCode": "litmusunify.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "litmusunify.reconnectInterval.label",
"ToolTip": "Seconds to wait after a lost or failed connection before the next attempt.",
"ToolTipCode": "litmusunify.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "litmusunify.workersCount.label",
"ToolTip": "Messages published in parallel. Higher values raise throughput and resource usage.",
"ToolTipCode": "litmusunify.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "UnifyHierarchy",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": true,
"Advanced": null,
"Label": "Unify Hierarchy",
"LabelCode": "litmusunify.UnifyHierarchy.label",
"ToolTip": "Slash-separated namespace levels this edge publishes under; each is resolved from payload metadata.",
"ToolTipCode": "litmusunify.UnifyHierarchy.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "litmusunify.caCert.label",
"ToolTip": "PEM CA verifying the broker over TLS. Set by registration; replace it, or clear it to fall back.",
"ToolTipCode": "litmusunify.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"mqtts",
"wss"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "litmusunify.pingTimeout.label",
"ToolTip": "Seconds to wait for the broker's keep-alive reply before the link counts as lost; checked every 5 s.",
"ToolTipCode": "litmusunify.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name"
],
"Order": [
"name",
"token",
"insecureSkipVerify",
"connectionType",
"port",
"path",
"caCert",
"UnifyClientID",
"UnifyHierarchy",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"jsonConfig",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Litmus UNS (Gen 1)
POST {{edgeUrl}}/cc/v2
Litmus UNS (Gen 1) — Provider Schema
Provider ID: 2a7e325f-0dc5-4069-be4b-a6ba88d6f8a4
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
token |
string | Litmus UNS Token | No | `` | - |
UNSClientID |
string | MQTT Client ID | No | `` | - |
UNSHierarchy |
string | UNS Hierarchy | No | `` | - |
caCert |
string | CA Certificate | No | `` | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
insecureSkipVerify |
boolean | Insecure skip verify | No | False |
- |
name |
string | Name | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "2a7e325f-0dc5-4069-be4b-a6ba88d6f8a4"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/litmusuns.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "litmusuns.throttlingLimit.label",
"ToolTip": "Maximum number of messages processed per second. Set to 0 to disable throttling.",
"ToolTipCode": "litmusuns.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "litmusuns.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "litmusuns.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Litmus UNS Token",
"LabelCode": "litmusuns.token.label",
"ToolTip": "Base64 one-time Token to access Litmus UNS endpoint",
"ToolTipCode": "litmusuns.token.tooltip",
"Example": "",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "UNSClientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": false,
"Advanced": null,
"Label": "MQTT Client ID",
"LabelCode": "litmusuns.clientId.label",
"ToolTip": "Litmus UNS MQTT Client ID",
"ToolTipCode": "litmusuns.clientId.tooltip",
"Example": "",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "UNSHierarchy",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": true,
"Advanced": null,
"Label": "UNS Hierarchy",
"LabelCode": "litmusuns.UNSHierarchy.label",
"ToolTip": "Read-only display of the UNS topic hierarchy levels configured for this connector instance.",
"ToolTipCode": "litmusuns.UNSHierarchy.tooltip",
"Example": "",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "litmusuns.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "litmusuns.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "jsonConfig",
"Value": {
"Type": "string",
"Hidden": true,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": null,
"MaskedType": "protected",
"ReadOnly": true,
"Advanced": null,
"Label": "MQTT Config",
"LabelCode": "litmusuns.jsonConfig.label",
"ToolTip": "MQTT connection info",
"ToolTipCode": "litmusuns.jsonConfig.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "litmusuns.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "litmusuns.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "litmusuns.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "litmusuns.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "litmusuns.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "litmusuns.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "litmusuns.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "litmusuns.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "litmusuns.insecureSkipVerify.label",
"ToolTip": "Skip TLS certificate verification for the Litmus UNS connection. Use only in development or trusted network environments.",
"ToolTipCode": "litmusuns.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "litmusuns.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Litmus UNS",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name"
],
"Order": [
"name",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"UNSClientID",
"insecureSkipVerify",
"caCert",
"UNSHierarchy",
"token",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MaintainX API
POST {{edgeUrl}}/cc/v2
MaintainX API — Provider Schema
Provider ID: d0e3f2c4-4a8b-4a12-9c37-2b9f0a3d5c8b
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
retryCount |
integer | Retry Count | No | 0 |
- |
bearerToken |
string | Bearer Token | Yes | - | - |
name |
string | Name | Yes | - | - |
organizationId |
string | Organization ID | No | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
requestTimeout |
integer | Request Timeout (s) | No | 10 |
- |
responseMode |
string | Response Mode | No | body_only |
body_only, full_metadata |
retryBackoff |
string | Retry Backoff | No | exponential |
none, fixed, exponential |
responseTopic |
string | Response Topic | No | - | - |
connectionCheckingInterval |
integer | Connection Checking Interval (s) | No | 300 |
- |
endpoint |
string | MaintainX Base URL | Yes | https://api.getmaintainx.com/v1 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
persistentStorage |
boolean | Persistent storage | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "d0e3f2c4-4a8b-4a12-9c37-2b9f0a3d5c8b"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/maintainx.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "retryCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 10,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Retry Count",
"LabelCode": "maintainx.retryCount.label",
"ToolTip": "Maximum number of retries on transport errors, 5xx, or 429",
"ToolTipCode": "maintainx.retryCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bearerToken",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Bearer Token",
"LabelCode": "maintainx.bearerToken.label",
"ToolTip": "MaintainX API token (JWT). Issued from Settings > Integrations > API Keys. Sent as Authorization: bearer <token>.",
"ToolTipCode": "maintainx.bearerToken.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "maintainx.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "organizationId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization ID",
"LabelCode": "maintainx.organizationId.label",
"ToolTip": "Optional. Sent as x-organization-id header for tokens scoped to multiple organizations.",
"ToolTipCode": "maintainx.organizationId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "maintainx.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling. MaintainX meter-reading endpoints allow ~100 requests / 60 seconds.",
"ToolTipCode": "maintainx.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "maintainx.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "maintainx.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request Timeout (s)",
"LabelCode": "maintainx.requestTimeout.label",
"ToolTip": "Per-request timeout in seconds",
"ToolTipCode": "maintainx.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "responseMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "body_only",
"Minimum": null,
"Maximum": null,
"Enum": [
"body_only",
"full_metadata"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Response Mode",
"LabelCode": "maintainx.responseMode.label",
"ToolTip": "body_only publishes correlationId+statusCode+body; full_metadata also includes headers, latencyMs, and error",
"ToolTipCode": "maintainx.responseMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "retryBackoff",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "exponential",
"Minimum": null,
"Maximum": null,
"Enum": [
"none",
"fixed",
"exponential"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Retry Backoff",
"LabelCode": "maintainx.retryBackoff.label",
"ToolTip": "Retry backoff strategy. Retry-After is honored on 429.",
"ToolTipCode": "maintainx.retryBackoff.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "responseTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Response Topic",
"LabelCode": "maintainx.responseTopic.label",
"ToolTip": "NATS topic the MaintainX POST response envelope is published to",
"ToolTipCode": "maintainx.responseTopic.tooltip",
"Example": "/response_topic",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionCheckingInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 300,
"Minimum": 0,
"Maximum": 3600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Checking Interval (s)",
"LabelCode": "maintainx.connectionCheckingInterval.label",
"ToolTip": "How often, in seconds, the connector checks the MaintainX endpoint for connectivity. Range 0\u20133600, default 300. 0 disables the periodic connection check \u2014 the connector will not detect outages or reconnect automatically.",
"ToolTipCode": "maintainx.connectionCheckingInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "https://api.getmaintainx.com/v1",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "MaintainX Base URL",
"LabelCode": "maintainx.endpoint.label",
"ToolTip": "MaintainX API base URL. Defaults to https://api.getmaintainx.com/v1; override only for sandbox/staging.",
"ToolTipCode": "maintainx.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"bearerToken"
],
"Order": [
"name",
"endpoint",
"bearerToken",
"organizationId",
"responseTopic",
"responseMode",
"workersCount",
"throttlingLimit",
"requestTimeout",
"retryCount",
"retryBackoff",
"connectionCheckingInterval",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Microsoft SQL Server
POST {{edgeUrl}}/cc/v2
Microsoft SQL Server — Provider Schema
Provider ID: 3474926c-eda9-4fbb-965d-c1ea76ea42ff
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
batchTimeout |
integer | Batch timeout | No | 500 |
- |
bulkInsertMode |
string | Bulk insert mode | No | values |
values, bulkcopy |
caCert |
string | CA Certificate | No | `` | - |
encrypt |
string | Encrypt | No | false |
disable, false, true, strict |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 1433 |
- |
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
mapping |
object | Mapping | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
createTable |
boolean | Create table | Yes | False |
- |
database |
string | Database | Yes | - | - |
enableJsonPath |
boolean | Enable JSONPath | No | False |
- |
table |
string | Table | Yes | - | - |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
hostname |
string | Hostname | Yes | - | - |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
password |
string | Password | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
schema |
string | Schema | No | dbo |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "3474926c-eda9-4fbb-965d-c1ea76ea42ff"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mssql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "mssql.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous commit attempt before a batch that is not yet full is written",
"ToolTipCode": "mssql.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkInsertMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "values",
"Minimum": null,
"Maximum": null,
"Enum": [
"values",
"bulkcopy"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert mode",
"LabelCode": "mssql.bulk_insert_mode.label",
"ToolTip": "Insert path: 'values' is a multi-row INSERT statement; 'bulkcopy' uses TDS bulk-copy (BCP) for higher throughput. 'bulkcopy' requires the default schema and is not compatible with a custom mapping.",
"ToolTipCode": "mssql.bulk_insert_mode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "mssql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "mssql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "encrypt",
"FieldValues": [
"true",
"strict"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "encrypt",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "false",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"false",
"true",
"strict"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Encrypt",
"LabelCode": "mssql.encrypt.label",
"ToolTip": "TLS/SSL encryption mode. disable: no TLS. false: TLS for login only, data in cleartext. true: TLS for login and data, validates server certificate. strict: TDS 8.0 strict TLS (SQL Server 2022+), validates server certificate with no fallback.",
"ToolTipCode": "mssql.encrypt.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mssql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mssql.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mssql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MSSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1433,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mssql.port.label",
"ToolTip": "Port of MSSQL host.",
"ToolTipCode": "mssql.port.tooltip",
"Example": 1433,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mssql.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert transaction may take before it is treated as failed and retried",
"ToolTipCode": "mssql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mssql.mapping.label",
"ToolTip": "Key is a column in your table. Value is a payload field name (deviceId), the matching default-schema column name (device_id), or static text prefixed with @ (@plant-a). Leave empty to use the default schema. Not compatible with Bulk insert mode 'bulkcopy'. When \"Enable JSONPath\" is on, a value starting with $ is read as a JSONPath expression instead of a field name.",
"ToolTipCode": "mssql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mssql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to commit, so this bounds how many rows a batch can collect.",
"ToolTipCode": "mssql.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "mssql.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is committed, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "mssql.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mssql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mssql.createTable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mssql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "enableJsonPath",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable JSONPath",
"LabelCode": "mssql.enableJsonPath.label",
"ToolTip": "Read mapping values that start with $ as JSONPath expressions, so a column can be filled from a nested payload field such as $.factory.line.machine.sensors.temperature. Dotted paths, quoted keys and array indexes are supported. Values that do not start with $ keep their usual meaning, and an expression matching nothing writes NULL.",
"ToolTipCode": "mssql.enableJsonPath.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mssql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mssql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mssql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mssql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mssql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mssql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "mssql.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but rows from different batches can be written out of publish order.",
"ToolTipCode": "mssql.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mssql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "dbo",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "mssql.schema.label",
"ToolTip": "Database schema for the target table (default: dbo)",
"ToolTipCode": "mssql.schema.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"encrypt",
"caCert",
"username",
"password",
"database",
"schema",
"table",
"mapping",
"enableJsonPath",
"createTable",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"bulkInsertMode",
"writeMode",
"parallelTransactions",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - MongoDB v4+
POST {{edgeUrl}}/cc/v2
MongoDB v4+ — Provider Schema
Provider ID: 3b1e4a2d-6c8f-4b9a-9d7e-5e2a1c3f4b8d
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
certificate |
string | Certificate | No | `` | - |
hostname |
string | Hostname | Yes | - | - |
privateKey |
string | Private key | No | `` | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
authMechanism |
string | Auth mechanism | No | DEFAULT |
DEFAULT, SCRAM-SHA-256, SCRAM-SHA-1, PLAIN, MONGODB-X509 |
batchTimeout |
integer | Batch timeout | No | 500 |
- |
enableJsonPath |
boolean | Enable JSONPath | No | False |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
caCert |
string | CA Certificate | No | `` | - |
createCollection |
boolean | Create collection | Yes | False |
- |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
username |
string | Username | No | - | - |
database |
string | Database | Yes | - | - |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
name |
string | Name | Yes | - | - |
authDatabase |
string | Auth database | No | admin |
- |
mapping |
object | Mapping | No | - | - |
port |
integer | Port | No | 27017 |
- |
scheme |
string | Connection scheme | Yes | mongodb |
mongodb, mongodb+srv |
sslMode |
string | SSL Mode | No | disable |
disable, require, verify-ca, verify-full |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
collection |
string | Collection | Yes | - | - |
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
password |
string | Password | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "3b1e4a2d-6c8f-4b9a-9d7e-5e2a1c3f4b8d"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mongodb.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "mongodb.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with MongoDB. Paste the PEM-encoded certificate here.",
"ToolTipCode": "mongodb.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mongodb.hostname.label",
"ToolTip": "DNS name or IP of the host. For mongodb+srv this is the SRV record name (e.g. cluster0.mongodb.net).",
"ToolTipCode": "mongodb.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "mongodb.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "mongodb.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authMechanism",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "DEFAULT",
"Minimum": null,
"Maximum": null,
"Enum": [
"DEFAULT",
"SCRAM-SHA-256",
"SCRAM-SHA-1",
"PLAIN",
"MONGODB-X509"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth mechanism",
"LabelCode": "mongodb.authMechanism.label",
"ToolTip": "Authentication mechanism. DEFAULT lets the driver negotiate the standard username/password mechanism (SCRAM-SHA-256 on MongoDB 4.0+, falls back to SCRAM-SHA-1). Use PLAIN for LDAP passthrough or MONGODB-X509 for TLS client certificate authentication.",
"ToolTipCode": "mongodb.authMechanism.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "mongodb.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous insert attempt before a batch that is not yet full is written",
"ToolTipCode": "mongodb.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "enableJsonPath",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable JSONPath",
"LabelCode": "mongodb.enableJsonPath.label",
"ToolTip": "Read mapping values that start with $ as JSONPath expressions, so a document field can be filled from a nested payload field such as $.factory.line.machine.sensors.temperature. Dotted paths, quoted keys and array indexes are supported; an expression that points at an object or array stores it as a nested document. Values that do not start with $ keep their usual meaning, and an expression matching nothing writes null.",
"ToolTipCode": "mongodb.enableJsonPath.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "mongodb.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is inserted, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "mongodb.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "mongodb.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "mongodb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "createCollection",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create collection",
"LabelCode": "mongodb.createCollection.label",
"ToolTip": "Create the collection if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mongodb.createCollection.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "mongodb.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but documents from different batches can be written out of publish order.",
"ToolTipCode": "mongodb.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mongodb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mongodb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mongodb.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mongodb.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mongodb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MongoDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authDatabase",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "admin",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Auth database",
"LabelCode": "mongodb.authDatabase.label",
"ToolTip": "Authentication database (authSource). Defaults to \"admin\". Set this to the data database name if the user was created inside the target database.",
"ToolTipCode": "mongodb.authDatabase.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mongodb.mapping.label",
"ToolTip": "Optional. Leave empty to write the whole incoming JSON object as-is (nested fields kept, MongoDB adds _id). Otherwise map document field names to message keys; prefix a value with @ for a static literal. When \"Enable JSONPath\" is on, a value starting with $ is read as a JSONPath expression instead of a message key.",
"ToolTipCode": "mongodb.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 27017,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mongodb.port.label",
"ToolTip": "Port of MongoDB host. Ignored when scheme is mongodb+srv.",
"ToolTipCode": "mongodb.port.tooltip",
"Example": 27017,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "scheme",
"FieldValues": [
"mongodb"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "scheme",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "mongodb",
"Minimum": null,
"Maximum": null,
"Enum": [
"mongodb",
"mongodb+srv"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection scheme",
"LabelCode": "mongodb.scheme.label",
"ToolTip": "Connection string scheme. \"mongodb\" connects to a single host on the given port. \"mongodb+srv\" resolves replica-set members via DNS SRV records (used by MongoDB Atlas) and enables TLS by default; the port field is ignored.",
"ToolTipCode": "mongodb.scheme.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "disable",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "mongodb.sslmode.label",
"ToolTip": "TLS/SSL connection mode. disable: no TLS. require: TLS without certificate validation. verify-ca: verify server certificate against CA. verify-full: verify CA and hostname.",
"ToolTipCode": "mongodb.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mongodb.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mongodb.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "collection",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Collection",
"LabelCode": "mongodb.collection.label",
"ToolTip": "Target collection to write data into. Must exist in the selected database unless \"Create collection\" is enabled.",
"ToolTipCode": "mongodb.collection.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mongodb.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert may take before it is treated as failed and retried",
"ToolTipCode": "mongodb.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mongodb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to be inserted, so this bounds how many documents a batch can collect.",
"ToolTipCode": "mongodb.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"scheme",
"hostname",
"database",
"collection",
"createCollection"
],
"Order": [
"name",
"scheme",
"hostname",
"port",
"sslMode",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"authDatabase",
"authMechanism",
"collection",
"mapping",
"enableJsonPath",
"createCollection",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"writeMode",
"parallelTransactions",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - MQTT - AWS IoT Core over SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - AWS IoT Core over SSL (Gen 1) — Provider Schema
Provider ID: f0df18e2-9ef9-480a-87e8-0510ef27d21d
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willRetained |
boolean | LWT retained | No | False |
- |
willTopic |
string | LWT topic | No | - | - |
clientId |
string | Client ID | No | - | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
willPayload |
string | LWT payload | No | - | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
privateKey |
string | Private key | Yes | `` | - |
certificate |
string | Certificate | Yes | `` | - |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
topic |
string | Integration Topic | Yes | - | - |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
hostname |
string | Hostname | Yes | - | - |
port |
integer | Port | No | 8883 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "f0df18e2-9ef9-480a-87e8-0510ef27d21d"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-iotcore-mqtt-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "aws.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "aws.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "aws.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "aws.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "aws.clientId.label",
"ToolTip": "Unique client identifier presented to the MQTT broker. Must be unique across all clients connected to the same broker.",
"ToolTipCode": "aws.clientId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "aws.qos.label",
"ToolTip": "QoS level: 0 = at most once, 1 = at least once. Note: AWS IoT Core does not support QoS 2.",
"ToolTipCode": "aws.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "aws.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "aws.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "aws.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "aws.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "aws.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "aws.privateKey.label",
"ToolTip": "Private key corresponding to the device certificate. Downloaded together with the certificate from AWS IoT Core.",
"ToolTipCode": "aws.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "aws.certificate.label",
"ToolTip": "Device certificate (X.509) downloaded from AWS IoT Core when registering the device. Paste PEM-encoded certificate here.",
"ToolTipCode": "aws.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "aws.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Amazon IoT Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "aws.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "aws.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "aws.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "aws.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "aws.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "aws.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "aws.topic.label",
"ToolTip": "AWS IoT Core MQTT topic to publish messages to. Supports AWS IoT rules engine routing and wildcards.",
"ToolTipCode": "aws.topic.tooltip",
"Example": "/events",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "aws.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "aws.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "aws.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "aws.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "aws.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "aws.hostname.tooltip",
"Example": "a1o8e9c82gegra.iot.us-east-2.amazonaws.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "aws.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "aws.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"topic",
"workersCount",
"certificate",
"privateKey"
],
"Order": [
"name",
"hostname",
"port",
"certificate",
"privateKey",
"clientId",
"qos",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - AWS IoT SiteWise Edge (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - AWS IoT SiteWise Edge (Gen 1) — Provider Schema
Provider ID: 69d06521-c16f-4f38-a9e9-4cd0f0edbfe7
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
port |
integer | Port | Yes | 8883 |
- |
willPayload |
string | LWT payload | No | - | - |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
propertyAlias |
string | Property Alias | Yes | - | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
additionalAliasDefinition |
string | Additional Alias Definition | No | - | - |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
name |
string | Instance Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
clientId |
string | Client ID | Yes | - | - |
hostname |
string | Hostname | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Integration Topic | Yes | - | - |
willTopic |
string | LWT topic | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "69d06521-c16f-4f38-a9e9-4cd0f0edbfe7"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/aws-sitewise-.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "aws.sitewiseedge.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "aws.sitewiseedge.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "aws.sitewiseedge.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "aws.sitewiseedge.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "aws.sitewiseedge.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "aws.sitewiseedge.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "aws.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "aws.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "aws.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "aws.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "aws.sitewiseedge.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.sitewiseedge.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "aws.sitewiseedge.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "aws.sitewiseedge.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "propertyAlias",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Property Alias",
"LabelCode": "aws.sitewiseedge.propertyAlias.label",
"ToolTip": "AWS IoT Sitewise Asset Property Alias",
"ToolTipCode": "aws.sitewiseedge.propertyAlias.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "aws.sitewiseedge.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "aws.sitewiseedge.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "additionalAliasDefinition",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Additional Alias Definition",
"LabelCode": "aws.sitewiseedge.additionalAliasDefinition.label",
"ToolTip": "Optional string to further define dynamic propertyAlias and Integration Topic",
"ToolTipCode": "aws.sitewiseedge.additionalAliasDefinition.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "aws.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "aws.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Instance Name",
"LabelCode": "aws.sitewiseedge.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "AWS IoT Sitewise Edge connector",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "aws.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "aws.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "aws.sitewiseedge.clientId.label",
"ToolTip": "Unique client identifier presented to the MQTT broker. Must be unique across all clients connected to the same broker.",
"ToolTipCode": "aws.sitewiseedge.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "aws.sitewiseedge.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "aws.sitewiseedge.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "aws.sitewiseedge.throttlingLimit.label",
"ToolTip": "Maximum number of messages processed per second. Set to 0 to disable throttling.",
"ToolTipCode": "aws.sitewiseedge.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "aws.sitewiseedge.topic.label",
"ToolTip": "MQTT topic used by the SiteWise Edge gateway for data ingestion. Must match the topic configured in the gateway settings.",
"ToolTipCode": "aws.sitewiseedge.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "aws.sitewiseedge.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "aws.sitewiseedge.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"clientId",
"propertyAlias",
"topic"
],
"Order": [
"name",
"hostname",
"port",
"clientId",
"propertyAlias",
"topic",
"additionalAliasDefinition",
"qos",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - MQTT - Azure IoT Hub using Device Certificates (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - Azure IoT Hub using Device Certificates (Gen 1) — Provider Schema
Provider ID: 395bf3a8-17f9-4ebf-8bd9-23d1b88d887e
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
port |
integer | Port | No | 8883 |
- |
privateKey |
string | Private key | Yes | `` | - |
willPayload |
string | LWT payload | No | - | - |
willRetained |
boolean | LWT retained | No | False |
- |
certificate |
string | Certificate | Yes | `` | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
workersCount |
integer | Parallel Publish Count | Yes | 16 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
deviceId |
string | Device ID | Yes | - | - |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
topic |
string | Integration Topic | No | devices/{deviceId}/messages/events/ |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
willTopic |
string | LWT topic | No | - | - |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
hostname |
string | Hostname | Yes | {IoTHub}.azure-devices.net |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "395bf3a8-17f9-4ebf-8bd9-23d1b88d887e"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/azure-iothub-mqtt-device-cert.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "azureIoT.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "azureIoT.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "azureIoT.privateKey.label",
"ToolTip": "Private key corresponding to the device certificate.",
"ToolTipCode": "azureIoT.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "azureIoT.certificate.label",
"ToolTip": "Device certificate (X.509) registered for this device in Azure IoT Hub. Paste PEM-encoded certificate here.",
"ToolTipCode": "azureIoT.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 16,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "azureIoT.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "azureIoT.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "deviceId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device ID",
"LabelCode": "azureIoT.deviceId.label",
"ToolTip": "ID of the device as shown in your Azure IoT hub.",
"ToolTipCode": "azureIoT.deviceId.tooltip",
"Example": "loopedge-000c29dedd9e",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "azureIoT.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Azure IoT Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "azureIoT.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "azureIoT.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "azureIoT.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "azureIoT.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "devices/{deviceId}/messages/events/",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "azureIoT.topic.label",
"ToolTip": "Azure IoT Hub MQTT topic for device-to-cloud telemetry. Default: devices/{deviceId}/messages/events/.",
"ToolTipCode": "azureIoT.topic.tooltip",
"Example": "devices/loopedge-000c29dedd9e/messages/events/",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "azureIoT.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "azureIoT.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "azureIoT.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "azureIoT.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "azureIoT.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "azureIoT.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "{IoTHub}.azure-devices.net",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "azureIoT.hostname.label",
"ToolTip": "DNS name of MQTT host. It can be found in \"Overview\" tab of your Azure IoT hub.",
"ToolTipCode": "azureIoT.hostname.tooltip",
"Example": "loopedge.azure-devices.net",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"deviceId",
"certificate",
"privateKey",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"deviceId",
"certificate",
"privateKey",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - Azure IoT Hub using SAS Key (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - Azure IoT Hub using SAS Key (Gen 1) — Provider Schema
Provider ID: 02fcf6e4-fcdf-490e-b578-1e8b4cf03684
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
port |
integer | Port | No | 8883 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
willPayload |
string | LWT payload | No | - | - |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
deviceId |
string | Device ID | Yes | - | - |
name |
string | Name | Yes | - | - |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
tokenTTL |
integer | Token TTL (minutes) | Yes | 1440 |
- |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
willRetained |
boolean | LWT retained | No | False |
- |
willTopic |
string | LWT topic | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
topic |
string | Integration Topic | No | devices/{deviceId}/messages/events/ |
- |
workersCount |
integer | Parallel Publish Count | Yes | 16 |
- |
hostname |
string | Hostname | Yes | {IoTHub}.azure-devices.net |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
sasKey |
string | SAS Key | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "02fcf6e4-fcdf-490e-b578-1e8b4cf03684"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/azure-iothub-mqtt-sas-key.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "azureIoT.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "azureIoT.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "azureIoT.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "azureIoT.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "azureIoT.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "azureIoT.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "azureIoT.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "azureIoT.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "azureIoT.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "azureIoT.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "azureIoT.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "azureIoT.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device ID",
"LabelCode": "azureIoT.deviceId.label",
"ToolTip": "ID of the device as shown in your Azure IoT account.",
"ToolTipCode": "azureIoT.deviceId.tooltip",
"Example": "loopedge-000c29dedd9e",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "azureIoT.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Azure IoT Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "azureIoT.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "azureIoT.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tokenTTL",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1440,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Token TTL (minutes)",
"LabelCode": "azureIoT.tokenTTL.label",
"ToolTip": "The token expiry time in minutes",
"ToolTipCode": "azureIoT.tokenTTL.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "azureIoT.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "azureIoT.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "azureIoT.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "azureIoT.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "azureIoT.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "azureIoT.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "devices/{deviceId}/messages/events/",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "azureIoT.topic.label",
"ToolTip": "Azure IoT Hub MQTT topic for device-to-cloud telemetry. Default: devices/{deviceId}/messages/events/.",
"ToolTipCode": "azureIoT.topic.tooltip",
"Example": "devices/loopedge-000c29dedd9e/messages/events/",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 16,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "azureIoT.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "azureIoT.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "{IoTHub}.azure-devices.net",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "azureIoT.hostname.label",
"ToolTip": "DNS name of MQTT host. It can be found in \"Overview\" tab of your Azure IoT hub.",
"ToolTipCode": "azureIoT.hostname.tooltip",
"Example": "loopedge.azure-devices.net",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sasKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "SAS Key",
"LabelCode": "azureIoT.key.label",
"ToolTip": "Primary or secondary shared access key.",
"ToolTipCode": "azureIoT.sasKey.tooltip",
"Example": "elACzLnthGKteZLCk2TF30OppwFdABZr+k8J+WBhzLo=",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"deviceId",
"sasKey",
"tokenTTL",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"deviceId",
"sasKey",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"tokenTTL",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - Generic
POST {{edgeUrl}}/cc/v2
MQTT - Generic — Provider Schema
Provider ID: 0e04a6f5-dc0c-4bd8-84b9-dc2b1b74b110
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
pingTimeout |
integer | Ping Timeout (seconds) | No | 7 |
- |
port |
integer | Port | No | 1883 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
privateKey |
string | Private key | No | `` | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
name |
string | Name | Yes | - | - |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
topic |
string | Integration Topic | Yes | - | - |
username |
string | Username | No | - | - |
willPayload |
string | LWT payload | No | - | - |
willRetained |
boolean | LWT retained | No | False |
- |
willTopic |
string | LWT topic | No | - | - |
caCert |
string | CA Certificate | Yes, when connectionType is ssl |
`` | - |
certificate |
string | Certificate | No | `` | - |
clientId |
string | Client ID | No | - | - |
hostname |
string | Hostname | Yes | - | - |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
connectionType |
string | Connection Type | Yes | tcp |
tcp, ssl |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "0e04a6f5-dc0c-4bd8-84b9-dc2b1b74b110"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/generic-mqtt-tcp.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 7,
"Minimum": 3,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Ping Timeout (seconds)",
"LabelCode": "generic.pingTimeout.label",
"ToolTip": "The time a client waits for a ping response from the broker after sending a PINGREQ message",
"ToolTipCode": "generic.pingTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "generic.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "generic.port.tooltip",
"Example": "1883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "generic.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "generic.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "generic.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Generic MQTT",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "generic.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "generic.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "generic.topic.label",
"ToolTip": "MQTT topic path where data is published.",
"ToolTipCode": "generic.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "generic.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and immediately delivers it to any new subscriber on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "generic.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "generic.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "generic.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the MQTT broker. Paste the PEM-encoded certificate here.",
"ToolTipCode": "generic.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "generic.clientId.label",
"ToolTip": "Client ID is required by MQTT server.",
"ToolTipCode": "generic.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "generic.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "generic.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "generic.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "tcp",
"Minimum": null,
"Maximum": null,
"Enum": [
"tcp",
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "generic.connectionType.label",
"ToolTip": "Choose tcp for an unencrypted connection or ssl for a TLS-encrypted connection to the MQTT broker.",
"ToolTipCode": "generic.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"workersCount",
"topic",
"connectionType"
],
"Order": [
"name",
"connectionType",
"hostname",
"port",
"caCert",
"certificate",
"privateKey",
"clientId",
"username",
"password",
"qos",
"workersCount",
"topic",
"pingTimeout",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - Generic (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - Generic (Gen 1) — Provider Schema
Provider ID: 91d5953e-91bd-4564-acf8-05d662ddb090
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
clientId |
string | Client ID | No | - | - |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
port |
integer | Port | No | 1883 |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
name |
string | Name | Yes | - | - |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayload |
string | LWT payload | No | - | - |
willRetained |
boolean | LWT retained | No | False |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
willTopic |
string | LWT topic | No | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
hostname |
string | Hostname | Yes | - | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
topic |
string | Integration Topic | No | - | - |
username |
string | Username | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "91d5953e-91bd-4564-acf8-05d662ddb090"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/generic-mqtt-tcp.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "generic.clientId.label",
"ToolTip": "Unique client identifier presented to the MQTT broker. Must be unique across all clients connected to the same broker.",
"ToolTipCode": "generic.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "generic.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "generic.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "generic.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "generic.port.tooltip",
"Example": "1883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "generic.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "generic.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "generic.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "generic.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Generic MQTT",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "generic.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "generic.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "generic.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "generic.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "generic.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "generic.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "generic.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "generic.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "generic.topic.label",
"ToolTip": "MQTT topic path messages are published to. Can use template variables where supported by the broker.",
"ToolTipCode": "generic.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "generic.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"clientId",
"username",
"password",
"qos",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - Generic over SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - Generic over SSL (Gen 1) — Provider Schema
Provider ID: 53efdc1f-4e02-413f-b28d-b69334041718
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
caCert |
string | CA Certificate | No | `` | - |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
password |
string | Password | No | - | - |
port |
integer | Port | No | 8883 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
privateKey |
string | Private key | No | `` | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
topic |
string | Integration Topic | No | - | - |
username |
string | Username | No | - | - |
clientId |
string | Client ID | No | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayload |
string | LWT payload | No | - | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
willRetained |
boolean | LWT retained | No | False |
- |
willTopic |
string | LWT topic | No | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
certificate |
string | Certificate | No | `` | - |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "53efdc1f-4e02-413f-b28d-b69334041718"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/generic-mqtt-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "generic.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "generic.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "generic.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "generic.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "generic.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "generic.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "generic.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "generic.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "generic.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "generic.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "generic.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Generic MQTT",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "generic.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate.",
"ToolTipCode": "generic.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "generic.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "generic.topic.label",
"ToolTip": "MQTT topic path messages are published to. Can use template variables where supported by the broker.",
"ToolTipCode": "generic.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "generic.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "generic.clientId.label",
"ToolTip": "Unique client identifier presented to the MQTT broker. Must be unique across all clients connected to the same broker.",
"ToolTipCode": "generic.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "generic.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the MQTT broker. Paste PEM-encoded certificate here.",
"ToolTipCode": "generic.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "generic.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "generic.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "generic.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "generic.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "generic.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "generic.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"caCert",
"certificate",
"privateKey",
"clientId",
"username",
"password",
"qos",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - IBM Watson over SSL
POST {{edgeUrl}}/cc/v2
MQTT - IBM Watson over SSL — Provider Schema
Provider ID: 1009066e-58be-455b-9767-c196ae876d4e
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
topic |
string | Integration Topic | Yes | - | - |
username |
string | Username | No | - | - |
willRetained |
boolean | LWT retained | No | False |
- |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
deviceId |
string | Device ID | Yes | - | - |
name |
string | Name | Yes | - | - |
password |
string | Password | No | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
willTopic |
string | LWT topic | No | - | - |
clientId |
string | Client ID | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
deviceType |
string | Device Type | Yes | - | - |
hostname |
string | Hostname | Yes | {orgId}.messaging.internetofthings.ibmcloud.com |
- |
pingTimeout |
integer | Ping Timeout (seconds) | No | 7 |
- |
port |
integer | Port | Yes | 8883 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
token |
string | Token | Yes | - | - |
willPayload |
string | LWT payload | No | - | - |
caCert |
string | CA Certificate | No | `` | - |
orgId |
string | Organization ID | Yes | `` | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "1009066e-58be-455b-9767-c196ae876d4e"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/generic-mqtt-ibm-watson.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "generic.topic.label",
"ToolTip": "MQTT topic path where data is published.",
"ToolTipCode": "generic.topic.tooltip",
"Example": "iot-2/evt/status/fmt/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "generic.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and immediately delivers it to any new subscriber on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device ID",
"LabelCode": "ibm.deviceId.label",
"ToolTip": "Device ID is required by MQTT server.",
"ToolTipCode": "ibm.deviceId.tooltip",
"Example": "Device1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "IBM Watson MQTT",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "generic.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "generic.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "generic.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "generic.clientId.label",
"ToolTip": "Client ID is required by MQTT server.",
"ToolTipCode": "generic.clientId.tooltip",
"Example": "d:orgId:deviceType:deviceId",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": true,
"Default": "ssl",
"Minimum": null,
"Maximum": null,
"Enum": [
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "generic.connectionType.label",
"ToolTip": "IBM Watson requires a TLS-encrypted connection; ssl is the only supported option.",
"ToolTipCode": "generic.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device Type",
"LabelCode": "ibm.deviceType.label",
"ToolTip": "Device Type is required by MQTT server.",
"ToolTipCode": "ibm.deviceType.tooltip",
"Example": "DeviceType1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "{orgId}.messaging.internetofthings.ibmcloud.com",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "generic.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "generic.hostname.tooltip",
"Example": "{orgId}.messaging.internetofthings.ibmcloud.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 7,
"Minimum": 3,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Ping Timeout (seconds)",
"LabelCode": "generic.pingTimeout.label",
"ToolTip": "The time a client waits for a ping response from the broker after sending a PINGREQ message",
"ToolTipCode": "generic.pingTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "generic.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "generic.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Token",
"LabelCode": "ibm.token.label",
"ToolTip": "Token that was generated when the device was registered with Watson IoT Platform.",
"ToolTipCode": "ibm.token.tooltip",
"Example": "?BElVYV71FDTLr2CT7",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "generic.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "generic.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "orgId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization ID",
"LabelCode": "ibm.orgId.label",
"ToolTip": "The unique six-character organization ID",
"ToolTipCode": "ibm.orgId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "generic.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"orgId",
"deviceType",
"deviceId",
"token",
"workersCount",
"topic"
],
"Order": [
"name",
"hostname",
"port",
"caCert",
"orgId",
"deviceType",
"deviceId",
"token",
"clientId",
"username",
"password",
"qos",
"workersCount",
"topic",
"pingTimeout",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - IBM Watson over SSL (Gen 1)
POST {{edgeUrl}}/cc/v2
MQTT - IBM Watson over SSL (Gen 1) — Provider Schema
Provider ID: 3f87d2be-a30e-4304-b618-b9f1b48d21a3
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
persistentStorage |
boolean | Persistent storage | No | True |
- |
pingTimeout |
integer | Ping Timeout | No | 10 |
- |
publishWaitTimeout |
integer | Publish Wait Timeout | No | 10 |
- |
willPayload |
string | LWT payload | No | - | - |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
caCert |
string | CA Certificate | No | `` | - |
deviceType |
string | Device Type | Yes | - | - |
hostname |
string | Hostname | Yes | {orgId}.messaging.internetofthings.ibmcloud.com |
- |
token |
string | Token | Yes | - | - |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
name |
string | Name | Yes | - | - |
reconnectInterval |
integer | Reconnect Interval | No | 5 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
willRetained |
boolean | LWT retained | No | False |
- |
willTopic |
string | LWT topic | No | - | - |
deviceId |
string | Device ID | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
port |
integer | Port | Yes | 8883 |
- |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
topic |
string | Integration Topic | Yes | - | - |
connectTimeout |
integer | Connection Timeout | No | 30 |
- |
orgId |
string | Organization ID | Yes | `` | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "3f87d2be-a30e-4304-b618-b9f1b48d21a3"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/ibm-watson-mqtt-ssl.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "pingTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 5,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Ping Timeout",
"LabelCode": "ibm.pingTimeout.label",
"ToolTip": "How long to wait for the broker's keep-alive response before the connection is treated as lost. Checked every 5 seconds, so the value is rounded up to the next 5 second step.",
"ToolTipCode": "ibm.pingTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishWaitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Publish Wait Timeout",
"LabelCode": "ibm.publishWaitTimeout.label",
"ToolTip": "How long a single publish may take before it is given up on, in seconds.",
"ToolTipCode": "ibm.publishWaitTimeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload",
"LabelCode": "ibm.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "ibm.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT payload type",
"LabelCode": "ibm.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "ibm.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "ibm.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "ibm.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device Type",
"LabelCode": "ibm.deviceType.label",
"ToolTip": "Device type registered in Watson IoT Platform. Combined with the device ID to identify this client.",
"ToolTipCode": "ibm.deviceType.tooltip",
"Example": "DeviceType1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "{orgId}.messaging.internetofthings.ibmcloud.com",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "ibm.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "ibm.hostname.tooltip",
"Example": "{orgId}.messaging.internetofthings.ibmcloud.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Token",
"LabelCode": "ibm.token.label",
"ToolTip": "Token that was generated when the device was registered with Watson IoT Platform.",
"ToolTipCode": "ibm.token.tooltip",
"Example": "?BElVYV71FDTLr2CT7",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT QoS",
"LabelCode": "ibm.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "ibm.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "ibm.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "ibm.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "ibm.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "IBM watson",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "reconnectInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Reconnect Interval",
"LabelCode": "ibm.reconnectInterval.label",
"ToolTip": "How long to wait after a lost or failed connection before the next attempt, in seconds.",
"ToolTipCode": "ibm.reconnectInterval.tooltip",
"Example": 5,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT retained",
"LabelCode": "ibm.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and delivers it immediately to new subscribers on that topic.",
"ToolTipCode": "ibm.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "LWT topic",
"LabelCode": "ibm.willTopic.label",
"ToolTip": "Topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "ibm.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "deviceId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Device ID",
"LabelCode": "ibm.deviceId.label",
"ToolTip": "Device identifier registered in Watson IoT Platform for this client.",
"ToolTipCode": "ibm.deviceId.tooltip",
"Example": "Device1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "ibm.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "ibm.port.tooltip",
"Example": "8883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "ibm.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "ibm.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "ibm.topic.label",
"ToolTip": "Watson IoT Platform MQTT topic for device events.",
"ToolTipCode": "ibm.topic.tooltip",
"Example": "iot-2/evt/status/fmt/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "ibm.connectTimeout.label",
"ToolTip": "How long a single connection attempt may take before it is abandoned, in seconds.",
"ToolTipCode": "ibm.connectTimeout.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "orgId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Organization ID",
"LabelCode": "ibm.orgId.label",
"ToolTip": "The unique six-character organization ID",
"ToolTipCode": "ibm.orgId.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"orgId",
"deviceType",
"deviceId",
"token",
"topic",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"caCert",
"orgId",
"deviceType",
"deviceId",
"token",
"qos",
"workersCount",
"connectTimeout",
"pingTimeout",
"reconnectInterval",
"publishWaitTimeout",
"topic",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MQTT - v5 Generic
POST {{edgeUrl}}/cc/v2
MQTT - v5 Generic — Provider Schema
Provider ID: 6d460871-d540-491d-89ea-909b783a222a
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
caCert |
string | CA Certificate | No | `` | - |
connectionTimeout |
integer | Connection Timeout | No | 10 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
willPayloadType |
string | LWT payload type | No | string |
string, base64 |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
requestProblemInfo |
boolean | Request Problem Info | No | False |
- |
requestResponseInfo |
boolean | Request Response Info | No | False |
- |
clientId |
string | Client ID | No | - | - |
hostname |
string | Hostname | Yes | - | - |
port |
integer | Port | Yes | 1883 |
- |
privateKey |
string | Private key | No | `` | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
willRetained |
boolean | LWT retained | No | False |
- |
connectionType |
string | Connection Type | Yes | tcp |
tcp, ssl |
contentType |
string | Content type | No | - | - |
name |
string | Name | Yes | - | - |
payloadFormat |
string | Payload Format Indicator | No | utf-8 |
utf-8, byte |
sessionExpiryInterval |
integer | Session Expiry Interval (seconds) | No | 0 |
- |
willQoS |
integer | LWT QoS | No | 1 |
0, 1, 2 |
password |
string | Password | No | - | - |
qos |
integer | QoS | No | 1 |
0, 1, 2 |
userProperties |
object | User Properties | No | - | - |
insecureVerify |
boolean | Insecure Skip Verify | No | False |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Integration Topic | Yes | - | - |
responseTopic |
string | Response Topic | No | - | - |
certificate |
string | Certificate | No | `` | - |
messageExpiryInterval |
integer | Message Expiry Interval | No | 0 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
keepAlive |
integer | Keep Alive | No | 60 |
- |
topicAlias |
integer | Topic Alias Maximum | No | 7 |
- |
willPayload |
string | LWT payload | No | - | - |
willTopic |
string | LWT topic | No | - | - |
username |
string | Username | No | - | - |
willDelay |
integer | Will Delay Interval | No | 0 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "6d460871-d540-491d-89ea-909b783a222a"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/generic-mqtt-v5.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "generic.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "generic.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "connectionTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Connection Timeout",
"LabelCode": "generic.connectionTimeout.label",
"ToolTip": "How long to wait for the connection process to complete in seconds",
"ToolTipCode": "generic.connectionTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willPayloadType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "string",
"Minimum": null,
"Maximum": null,
"Enum": [
"string",
"base64"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload type",
"LabelCode": "generic.willPayloadType.label",
"ToolTip": "Encoding of the LWT payload: string for plain text, base64 for binary data.",
"ToolTipCode": "generic.willPayloadType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestProblemInfo",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Request Problem Info",
"LabelCode": "generic.requestProblemInfo.label",
"ToolTip": "Request the broker to include human-readable reason strings and user properties in error packets (PUBACK, SUBACK, etc.).",
"ToolTipCode": "generic.requestProblemInfo.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestResponseInfo",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Request Response Info",
"LabelCode": "generic.requestResponseInfo.label",
"ToolTip": "Request the broker to return response information (e.g. response topic prefix) in the CONNACK packet.",
"ToolTipCode": "generic.requestResponseInfo.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientId",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Client ID",
"LabelCode": "generic.clientId.label",
"ToolTip": "Client ID is required by MQTT server. If left empty, system will use InstanceUUID.",
"ToolTipCode": "generic.clientId.tooltip",
"Example": "5dlvtw2sbbn4hqltaecpit115",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "generic.hostname.label",
"ToolTip": "DNS name of MQTT host.",
"ToolTipCode": "generic.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1883,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "generic.port.label",
"ToolTip": "Port of MQTT host.",
"ToolTipCode": "generic.port.tooltip",
"Example": "1883",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "generic.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "generic.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "willRetained",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT retained",
"LabelCode": "generic.willRetained.label",
"ToolTip": "When enabled, the broker retains the Last Will message and immediately delivers it to any new subscriber on that topic.",
"ToolTipCode": "generic.willRetained.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "tcp",
"Minimum": null,
"Maximum": null,
"Enum": [
"tcp",
"ssl"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Type",
"LabelCode": "generic.connectionType.label",
"ToolTip": "Choose tcp for an unencrypted connection or ssl for a TLS-encrypted connection to the MQTT broker.",
"ToolTipCode": "generic.connectionType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "contentType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Content type",
"LabelCode": "generic.contentType.label",
"ToolTip": "MIME type describing the format of the message payload (e.g. application/json). Informational - passed to subscribers.",
"ToolTipCode": "generic.contentType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "generic.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Generic MQTT",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "payloadFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "utf-8",
"Minimum": null,
"Maximum": null,
"Enum": [
"utf-8",
"byte"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Payload Format Indicator",
"LabelCode": "generic.payloadFormat.label",
"ToolTip": "Allowing the server to understand packet without having to operate on the actual data",
"ToolTipCode": "generic.payloadFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sessionExpiryInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Session Expiry Interval (seconds)",
"LabelCode": "generic.sessionExpiryInterval.label",
"ToolTip": "The number that specifies how long a broker keeps a client's session information",
"ToolTipCode": "generic.sessionExpiryInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willQoS",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT QoS",
"LabelCode": "generic.willQoS.label",
"ToolTip": "QoS level for the Last Will message: 0 = at most once, 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.willQoS.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "generic.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "qos",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": null,
"Maximum": null,
"Enum": [
0,
1,
2
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "QoS",
"LabelCode": "generic.qos.label",
"ToolTip": "Quality of Service delivery guarantee: 0 = at most once (fire-and-forget), 1 = at least once, 2 = exactly once.",
"ToolTipCode": "generic.qos.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "userProperties",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "User Properties",
"LabelCode": "generic.userProperties.label",
"ToolTip": "Custom key-value metadata attached to outgoing MQTT v5 packets. Passed through to the broker and available to subscribers.",
"ToolTipCode": "generic.userProperties.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure Skip Verify",
"LabelCode": "generic.insecureSkipVerify.label",
"ToolTip": "InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name",
"ToolTipCode": "generic.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Integration Topic",
"LabelCode": "generic.topic.label",
"ToolTip": "MQTT topic path where data is published.",
"ToolTipCode": "generic.topic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "responseTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Response Topic",
"LabelCode": "generic.responseTopic.label",
"ToolTip": "MQTT v5 topic the receiver should publish its response to. Used in request-response messaging patterns.",
"ToolTipCode": "generic.responseTopic.tooltip",
"Example": "loop/data/5dlvtw2sbbn4hqltaecpit115/218zg9xqseuxr87zkkstoyaoz/json",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "generic.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with the MQTT broker. Paste the PEM-encoded certificate here.",
"ToolTipCode": "generic.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "connectionType",
"FieldValues": [
"ssl"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "messageExpiryInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 4294967295,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Message Expiry Interval",
"LabelCode": "generic.messageExpiryInterval.label",
"ToolTip": "Allow an expiry interval to be set when a message is published",
"ToolTipCode": "generic.messageExpiryInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "keepAlive",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 60,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Keep Alive",
"LabelCode": "generic.keepAlive.label",
"ToolTip": "Ensure that client remains connected to the broker and maintains an active session",
"ToolTipCode": "generic.keepAlive.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topicAlias",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 7,
"Minimum": 1,
"Maximum": 7,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Topic Alias Maximum",
"LabelCode": "generic.topicAlias.label",
"ToolTip": "Decrease the size of the MQTT packet overhead by allowing the topic name to be abbreviated to a small integer",
"ToolTipCode": "generic.topicAlias.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willPayload",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT payload",
"LabelCode": "generic.willPayload.label",
"ToolTip": "Message content published to the LWT topic on unexpected disconnection. Typically a status or alert string.",
"ToolTipCode": "generic.willPayload.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "LWT topic",
"LabelCode": "generic.willTopic.label",
"ToolTip": "MQTT topic the broker publishes the Last Will message to if this client disconnects unexpectedly.",
"ToolTipCode": "generic.willTopic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "generic.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "willDelay",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Will Delay Interval",
"LabelCode": "generic.willDelay.label",
"ToolTip": "Add the ability to specify a delay between the end of the connection and sending the will message",
"ToolTipCode": "generic.willDelay.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"connectionType",
"topic"
],
"Order": [
"name",
"connectionType",
"hostname",
"port",
"caCert",
"certificate",
"privateKey",
"insecureVerify",
"clientId",
"username",
"password",
"qos",
"topic",
"userProperties",
"workersCount",
"responseTopic",
"payloadFormat",
"contentType",
"topicAlias",
"willTopic",
"willPayload",
"willPayloadType",
"willQoS",
"willRetained",
"willDelay",
"sessionExpiryInterval",
"messageExpiryInterval",
"requestResponseInfo",
"requestProblemInfo",
"keepAlive",
"connectionTimeout",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - MySQL
POST {{edgeUrl}}/cc/v2
MySQL — Provider Schema
Provider ID: a9221fea-bb2e-40a5-8f3c-07968b809301
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
enableJsonPath |
boolean | Enable JSONPath | No | False |
- |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
name |
string | Name | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
username |
string | Username | Yes | - | - |
certificate |
string | Certificate | No | `` | - |
createTable |
boolean | Create table | Yes | False |
- |
password |
string | Password | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
port |
integer | Port | Yes | 3306 |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
batchTimeout |
integer | Batch timeout | No | 500 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
hostname |
string | Hostname | Yes | - | - |
mapping |
object | Mapping | No | - | - |
privateKey |
string | Private key | No | `` | - |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
caCert |
string | CA Certificate | No | `` | - |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
sslMode |
string | SSL Mode | No | disable |
disable, require |
table |
string | Table | Yes | - | - |
database |
string | Database | Yes | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "a9221fea-bb2e-40a5-8f3c-07968b809301"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/mysql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "enableJsonPath",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable JSONPath",
"LabelCode": "mysql.enableJsonPath.label",
"ToolTip": "Read mapping values that start with $ as JSONPath expressions, so a column can be filled from a nested payload field such as $.factory.line.machine.sensors.temperature. Dotted paths, quoted keys and array indexes are supported. Values that do not start with $ keep their usual meaning, and an expression matching nothing writes NULL.",
"ToolTipCode": "mysql.enableJsonPath.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "mysql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "mysql.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "mysql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "MySQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "mysql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "mysql.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with MySQL. Paste the PEM-encoded certificate here.",
"ToolTipCode": "mysql.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "mysql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "mysql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 3306,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "mysql.port.label",
"ToolTip": "Port of MySQL host.",
"ToolTipCode": "mysql.port.tooltip",
"Example": 3306,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "mysql.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is committed, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "mysql.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "mysql.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous commit attempt before a batch that is not yet full is written",
"ToolTipCode": "mysql.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "mysql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "mysql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "mysql.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert transaction may take before it is treated as failed and retried",
"ToolTipCode": "mysql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "mysql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "mysql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "mysql.mapping.label",
"ToolTip": "Key is a column in your table. Value is a payload field name (deviceId), the matching default-schema column name (device_id), or static text prefixed with @ (@plant-a). Leave empty to use the default schema. When \"Enable JSONPath\" is on, a value starting with $ is read as a JSONPath expression instead of a field name.",
"ToolTipCode": "mysql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "mysql.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "mysql.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to commit, so this bounds how many rows a batch can collect.",
"ToolTipCode": "mysql.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "mysql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "mysql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "mysql.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but rows from different batches can be written out of publish order.",
"ToolTipCode": "mysql.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "disable",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"require"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "mysql.sslmode.label",
"ToolTip": "Controls certificate validation: disable skips TLS entirely, require encrypts but skips verification, verify-ca validates the CA certificate, verify-full also validates the hostname.",
"ToolTipCode": "mysql.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "mysql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "mysql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "mysql.database.label",
"ToolTip": "In MySQL a database is the schema. Set this to the schema that holds the target table.",
"ToolTipCode": "mysql.database.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"sslMode",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"table",
"mapping",
"enableJsonPath",
"createTable",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"writeMode",
"parallelTransactions",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - NATS
POST {{edgeUrl}}/cc/v2
NATS — Provider Schema
Provider ID: b281db24-2092-4e8d-b735-f774bde9bd62
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
enableTLS |
boolean | Enable TLS secure connection | Yes | False |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
topic |
string | Default topic name | Yes | - | - |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
flushTimeoutSeconds |
integer | Flush timeout (second) | No | 2 |
- |
hostname |
string | Hostname | Yes | - | - |
insecureSkipVerify |
boolean | Insecure skip verify | No | False |
- |
maxReconnect |
integer | Max Reconnect | No | 5 |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 4222 |
- |
connectTimeoutSeconds |
integer | Connect timeout (second) | No | 2 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
reconnectWait |
integer | Reconnect wait (second) | No | 2 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
password |
string | NATS Password | No | - | - |
username |
string | NATS Username | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "b281db24-2092-4e8d-b735-f774bde9bd62"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/nats.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "enableTLS",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable TLS secure connection",
"LabelCode": "nats.enableTLS.label",
"ToolTip": "Encrypt the connection to the NATS server using TLS. Requires a valid server certificate. Use \"Insecure Skip Verify\" to bypass certificate validation during testing.",
"ToolTipCode": "nats.enableTLS.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Default topic name",
"LabelCode": "nats.topic.label",
"ToolTip": "Default NATS subject messages are published to when no subject override is provided by the data pipeline.",
"ToolTipCode": "nats.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 100000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "flushTimeoutSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2,
"Minimum": 1,
"Maximum": 300,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Flush timeout (second)",
"LabelCode": "nats.flushTimeoutSeconds.label",
"ToolTip": "Timeout for flushing buffered messages to the server during publish operations",
"ToolTipCode": "nats.flushTimeoutSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "nats.hostname.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "nats.insecureSkipVerify.label",
"ToolTip": "InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name.",
"ToolTipCode": "nats.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxReconnect",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5,
"Minimum": -1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max Reconnect",
"LabelCode": "nats.maxReconnect.label",
"ToolTip": "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)",
"ToolTipCode": "nats.maxReconnect.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "nats.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 4222,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "nats.port.label",
"ToolTip": "Port of NATS host.",
"ToolTipCode": "nats.port.tooltip",
"Example": "4222",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectTimeoutSeconds",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connect timeout (second)",
"LabelCode": "nats.connectTimeoutSeconds.label",
"ToolTip": "Timeout sets the timeout for a Dial operation on a connection",
"ToolTipCode": "nats.connectTimeoutSeconds.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "reconnectWait",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 2,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Reconnect wait (second)",
"LabelCode": "nats.reconnectWait.label",
"ToolTip": "ReconnectWait sets the time to backoff after attempting a reconnect to a server that we were already connected to previously",
"ToolTipCode": "nats.reconnectWait.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "NATS Password",
"LabelCode": "nats.password.label",
"ToolTip": "Password for authenticating with the NATS server. Leave empty if the server does not require authentication.",
"ToolTipCode": "nats.password.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "NATS Username",
"LabelCode": "nats.username.label",
"ToolTip": "Username for authenticating with the NATS server. Leave empty if the server does not require authentication.",
"ToolTipCode": "nats.username.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"topic",
"enableTLS",
"workersCount"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"topic",
"workersCount",
"enableTLS",
"insecureSkipVerify",
"maxReconnect",
"reconnectWait",
"connectTimeoutSeconds",
"flushTimeoutSeconds",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - NATS (Gen 1)
POST {{edgeUrl}}/cc/v2
NATS (Gen 1) — Provider Schema
Provider ID: 286b6ec7-4069-4022-81c4-6e4826a9662c
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
port |
integer | Port | Yes | 4222 |
- |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
enableTLS |
boolean | Enable TLS secure connection | Yes | False |
- |
password |
string | NATS Password | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
topic |
string | Default topic name | Yes | - | - |
username |
string | NATS Username | No | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
hostname |
string | Hostname | Yes | - | - |
insecureSkipVerify |
boolean | Insecure skip verify | No | False |
- |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "286b6ec7-4069-4022-81c4-6e4826a9662c"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/nats.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 4222,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "nats.port.label",
"ToolTip": "Port of NATS host.",
"ToolTipCode": "nats.port.tooltip",
"Example": "4222",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "enableTLS",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable TLS secure connection",
"LabelCode": "nats.enableTLS.label",
"ToolTip": "Enable encrypted TLS connection to the NATS server. When enabled, use \"Insecure Skip Verify\" to bypass certificate validation during development.",
"ToolTipCode": "nats.enableTLS.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "NATS Password",
"LabelCode": "nats.password.label",
"ToolTip": "Password for authenticating with the NATS server. Leave empty if the server does not require authentication.",
"ToolTipCode": "nats.password.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Default topic name",
"LabelCode": "nats.topic.label",
"ToolTip": "Default NATS subject messages are published to when no subject override is specified.",
"ToolTipCode": "nats.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "NATS Username",
"LabelCode": "nats.username.label",
"ToolTip": "Username for authenticating with the NATS server. Leave empty if the server does not require authentication.",
"ToolTipCode": "nats.username.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "nats.hostname.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "nats.insecureSkipVerify.label",
"ToolTip": "When enabled, the server's certificate chain and host name are not verified. Use only for testing, as this removes protection against man-in-the-middle attacks.",
"ToolTipCode": "nats.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "nats.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"topic",
"enableTLS"
],
"Order": [
"name",
"hostname",
"port",
"username",
"password",
"topic",
"enableTLS",
"insecureSkipVerify",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - Oracle Smart Operations in Fusion Cloud SCM
POST {{edgeUrl}}/cc/v2
Oracle Smart Operations in Fusion Cloud SCM — Provider Schema
Provider ID: 943ecb8a-b215-4d48-ab51-2855302a3916
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
headers |
object | Headers | No | - | - |
method |
string | Method | Yes | POST |
POST |
oAuth2ClientID |
string | OAuth2 - Client ID | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
oAuth2ClientSecret |
string | OAuth2 - Client Secret | Yes | - | - |
oAuth2Scope |
string | OAuth2 - Scope | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
endpoint |
string | Endpoint | Yes | - | - |
mapping |
object | Mapping | No | - | - |
name |
string | Name | Yes | - | - |
oAuth2TokenEndpoint |
string | OAuth2 - Token Endpoint | Yes | - | - |
params |
object | Params | No | - | - |
requestTimeout |
integer | Request timeout | No | 10 |
- |
responseTopic |
string | Response Topic | No | - | - |
insecureSkipVerify |
boolean | Insecure skip verify | No | True |
- |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "943ecb8a-b215-4d48-ab51-2855302a3916"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/rest.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "headers",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Headers",
"LabelCode": "rest.headers.label",
"ToolTip": "Custom HTTP headers sent with each request as key-value pairs. Example: Authorization: Bearer <token> or Content-Type: application/json.",
"ToolTipCode": "rest.headers.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "method",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "POST",
"Minimum": null,
"Maximum": null,
"Enum": [
"POST"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Method",
"LabelCode": "rest.method.label",
"ToolTip": "Method (Oracle Fusion Cloud supports POST only)",
"ToolTipCode": "rest.method.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2ClientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client ID",
"LabelCode": "rest.oauth2.clientID.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2ClientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client Secret",
"LabelCode": "rest.oauth2.clientSecret.label",
"ToolTip": "Client secret credential paired with the Client ID.",
"ToolTipCode": "rest.oauth2.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2Scope",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Scope",
"LabelCode": "rest.oauth2.scope.label",
"ToolTip": "OAuth2 - Scope (comma separated value)",
"ToolTipCode": "rest.oauth2.scope.tooltip",
"Example": "view,read",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "rest.endpoint.label",
"ToolTip": "Full URL of the Oracle Fusion Cloud REST API endpoint to POST data to.",
"ToolTipCode": "rest.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "rest.mapping.label",
"ToolTip": "Maps incoming message field names to Oracle REST API field names.",
"ToolTipCode": "rest.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "rest.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2TokenEndpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Token Endpoint",
"LabelCode": "rest.oauth2.tokenEndpoint.label",
"ToolTip": "URL of the OAuth2 token endpoint used to obtain access tokens before each request.",
"ToolTipCode": "rest.oauth2.tokenEndpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "params",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Params",
"LabelCode": "rest.params.label",
"ToolTip": "URL query parameters appended to the endpoint on each request, as key-value pairs.",
"ToolTipCode": "rest.params.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request timeout",
"LabelCode": "rest.requestTimeout.label",
"ToolTip": "Request timeout in seconds",
"ToolTipCode": "rest.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "responseTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Response Topic",
"LabelCode": "rest.responseTopic.label",
"ToolTip": "Nats response topic payload for All requests",
"ToolTipCode": "rest.responseTopic.tooltip",
"Example": "/response_topic",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "rest.insecureSkipVerify.label",
"ToolTip": "InsecureSkipVerify controls whether a client verifies the server's certificate chain and host name.",
"ToolTipCode": "rest.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "rest.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "rest.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"method",
"endpoint",
"workersCount",
"oAuth2TokenEndpoint",
"oAuth2ClientSecret",
"oAuth2ClientID"
],
"Order": [
"name",
"method",
"endpoint",
"oAuth2TokenEndpoint",
"oAuth2ClientID",
"oAuth2ClientSecret",
"oAuth2Scope",
"headers",
"params",
"mapping",
"requestTimeout",
"insecureSkipVerify",
"workersCount",
"responseTopic",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - OSI PI Historian
POST {{edgeUrl}}/cc/v2
OSI PI Historian — Provider Schema
Provider ID: 4663b683-0bfb-4bad-a51d-274b7bd15594
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
publishCountThreshold |
integer | Publish Count Threshold | Yes | 50 |
- |
requestTimeout |
integer | Request Timeout (ms) | Yes | 1000 |
- |
timezone |
string | Data Timezone | No | UTC |
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 |
checkTags |
boolean | Check Tags | No | True |
- |
description |
string | Description | No | - | - |
insecureSkipVerify |
boolean | Insecure Skip Verify | No | False |
- |
name |
string | Name | Yes | - | - |
publishDelayThreshold |
integer | Publish Delay Threshold (ms) | Yes | 1000 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
tagNameFormat |
string | Point Name Format | Yes | $S$V.$D.$N |
- |
caCert |
string | CA Certificate | No | `` | - |
dataSourceVersion |
string | Data Source Version | No | 1 |
- |
maxSubscriptionEvents |
integer | Max Subscription Events | Yes | 100 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
tagDescriptionFormat |
string | Point Description Format | No | $P |
- |
tagTypeFormat |
string | Point Datatype Format | Yes | TimeIndexed.$T.$S |
- |
dataSourceType |
string | Data Source Type | No | DH |
- |
endpoint |
string | Endpoint | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
subscribeInterval |
integer | Subscribe Interval (s) | Yes | 1 |
- |
username |
string | Username | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
password |
string | Password | Yes | - | - |
piServer |
string | PI Data Server Name | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "4663b683-0bfb-4bad-a51d-274b7bd15594"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/osipiweb.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishCountThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 50,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish Count Threshold",
"LabelCode": "osipiweb.countThreshold.label",
"ToolTip": "Publish count threshold (1 disables batching)",
"ToolTipCode": "osipiweb.countThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 30000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request Timeout (ms)",
"LabelCode": "osipiweb.requestTimeout.label",
"ToolTip": "HTTP Request Timeout in milliseconds",
"ToolTipCode": "osipiweb.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "timezone",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "UTC",
"Minimum": null,
"Maximum": null,
"Enum": [
"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"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Timezone",
"LabelCode": "osipiweb.timezone.label",
"ToolTip": "UTC Timezone of Outbound data",
"ToolTipCode": "osipiweb.timezone.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "afServer",
"Value": {
"Type": "string",
"Hidden": true,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "AssetFramework Server Name",
"LabelCode": "osipiweb.afServer.label",
"ToolTip": "Name of Asset Framework server",
"ToolTipCode": "osipiweb.afServer.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "checkTags",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Check Tags",
"LabelCode": "osipiweb.checkTags.label",
"ToolTip": "Check if point name exists before attempting to create new when writing",
"ToolTipCode": "osipiweb.checkTags.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "description",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Description",
"LabelCode": "osipiweb.description.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure Skip Verify",
"LabelCode": "osipiweb.insecureSkipVerify.label",
"ToolTip": "Disable server certificate chain and host name verification",
"ToolTipCode": "osipiweb.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "osipiweb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishDelayThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 0,
"Maximum": 600000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish Delay Threshold (ms)",
"LabelCode": "osipiweb.delayThreshold.label",
"ToolTip": "Publish delay threshold in milliseconds (0 disables batching)",
"ToolTipCode": "osipiweb.delayThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "tagNameFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "$S$V.$D.$N",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Name Format",
"LabelCode": "osipiweb.tagNameFormat.label",
"ToolTip": "Formatting directives for PI point name",
"ToolTipCode": "osipiweb.tagNameFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 2,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "osipiweb.caCert.label",
"ToolTip": "CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store.",
"ToolTipCode": "osipiweb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "dataSourceVersion",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "1",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Source Version",
"LabelCode": "osipiweb.dataSourceVersion.label",
"ToolTip": "Optional version suffix for root datasource, requires non-empty DataSourceType",
"ToolTipCode": "osipiweb.dataSourceVersion.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 16,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": true,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "osipiweb.database.label",
"ToolTip": "Name of Asset Framework database",
"ToolTipCode": "osipiweb.database.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxSubscriptionEvents",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 1000000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max Subscription Events",
"LabelCode": "osipiweb.maxSubscriptionEvents.label",
"ToolTip": "The maximum number of events processed per subscription poll (prioritised by most recent)",
"ToolTipCode": "osipiweb.maxSubscriptionEvents.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "tagDescriptionFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "$P",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Description Format",
"LabelCode": "osipiweb.tagDescriptionFormat.label",
"ToolTip": "Optional formatting directives for PI point description",
"ToolTipCode": "osipiweb.tagDescriptionFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tagTypeFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "TimeIndexed.$T.$S",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Datatype Format",
"LabelCode": "osipiweb.tagTypeFormat.label",
"ToolTip": "Formatting directives for PI point datatype (AF type name)",
"ToolTipCode": "osipiweb.tagTypeFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 2,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "dataSourceType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "DH",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Source Type",
"LabelCode": "osipiweb.dataSourceType.label",
"ToolTip": "Optional root name of datasource for PI points",
"ToolTipCode": "osipiweb.dataSourceType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 64,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "osipiweb.endpoint.label",
"ToolTip": "Base URL of the PI Web API server this connector connects to.",
"ToolTipCode": "osipiweb.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "subscribeInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 3600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe Interval (s)",
"LabelCode": "osipiweb.subscribeInterval.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "osipiweb.subscribeInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "osipiweb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "osipiweb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "piServer",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "PI Data Server Name",
"LabelCode": "osipiweb.piServer.label",
"ToolTip": "Optional name of PI Data Archive server",
"ToolTipCode": "osipiweb.piServer.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"username",
"password",
"requestTimeout",
"tagNameFormat",
"tagTypeFormat",
"subscribeInterval",
"maxSubscriptionEvents",
"publishDelayThreshold",
"publishCountThreshold"
],
"Order": [
"name",
"description",
"endpoint",
"username",
"password",
"insecureSkipVerify",
"caCert",
"timezone",
"dataSourceType",
"dataSourceVersion",
"tagNameFormat",
"tagTypeFormat",
"tagDescriptionFormat",
"checkTags",
"piServer",
"requestTimeout",
"publishDelayThreshold",
"publishCountThreshold",
"subscribeInterval",
"maxSubscriptionEvents",
"workersCount",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - OSI PI Historian (Gen 1)
POST {{edgeUrl}}/cc/v2
OSI PI Historian (Gen 1) — Provider Schema
Provider ID: 88a54a10-322a-4b9b-99e0-5a7b82a2f193
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
dataSourceVersion |
string | Data Source Version | No | 1 |
- |
name |
string | Name | Yes | - | - |
timezone |
string | Data Timezone | No | UTC |
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 |
username |
string | Username | Yes | - | - |
caCert |
string | CA Certificate | No | `` | - |
dataSourceType |
string | Data Source Type | No | DH |
- |
endpoint |
string | Endpoint | Yes | - | - |
maxSubscriptionEvents |
integer | Max Subscription Events | Yes | 100 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
piServer |
string | PI Data Server Name | No | - | - |
tagDescriptionFormat |
string | Point Description Format | No | $P |
- |
tagTypeFormat |
string | Point Datatype Format | Yes | TimeIndexed.$T.$S |
- |
description |
string | Description | No | - | - |
subscribeInterval |
integer | Subscribe Interval (s) | Yes | 1 |
- |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
insecureSkipVerify |
boolean | Insecure Skip Verify | No | False |
- |
checkTags |
boolean | Check Tags | No | True |
- |
requestTimeout |
integer | Request Timeout (ms) | Yes | 1000 |
- |
password |
string | Password | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
publishCountThreshold |
integer | Publish Count Threshold | Yes | 50 |
- |
compression |
boolean | Gzip Compression | No | True |
- |
publishDelayThreshold |
integer | Publish Delay Threshold (ms) | Yes | 1000 |
- |
tagNameFormat |
string | Point Name Format | Yes | $S$V.$D.$N |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "88a54a10-322a-4b9b-99e0-5a7b82a2f193"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/osipiweb.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "dataSourceVersion",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "1",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Source Version",
"LabelCode": "osipiweb.dataSourceVersion.label",
"ToolTip": "Optional version suffix for root datasource, requires non-empty DataSourceType",
"ToolTipCode": "osipiweb.dataSourceVersion.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 16,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "osipiweb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "timezone",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "UTC",
"Minimum": null,
"Maximum": null,
"Enum": [
"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"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Timezone",
"LabelCode": "osipiweb.timezone.label",
"ToolTip": "UTC Timezone of Outbound data",
"ToolTipCode": "osipiweb.timezone.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "osipiweb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "osipiweb.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "osipiweb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "dataSourceType",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "DH",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Data Source Type",
"LabelCode": "osipiweb.dataSourceType.label",
"ToolTip": "Optional root name of datasource for PI points",
"ToolTipCode": "osipiweb.dataSourceType.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 64,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "osipiweb.endpoint.label",
"ToolTip": "URL of the PI Web API OMF endpoint.",
"ToolTipCode": "osipiweb.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxSubscriptionEvents",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 1,
"Maximum": 1000000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max Subscription Events",
"LabelCode": "osipiweb.maxSubscriptionEvents.label",
"ToolTip": "The maximum number of events processed per subscription poll (prioritised by most recent)",
"ToolTipCode": "osipiweb.maxSubscriptionEvents.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "piServer",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "PI Data Server Name",
"LabelCode": "osipiweb.piServer.label",
"ToolTip": "Optional name of PI Data Archive server",
"ToolTipCode": "osipiweb.piServer.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tagDescriptionFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "$P",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Description Format",
"LabelCode": "osipiweb.tagDescriptionFormat.label",
"ToolTip": "Optional formatting directives for PI point description",
"ToolTipCode": "osipiweb.tagDescriptionFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": true,
"Required": null,
"MinLength": null,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tagTypeFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "TimeIndexed.$T.$S",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Datatype Format",
"LabelCode": "osipiweb.tagTypeFormat.label",
"ToolTip": "Formatting directives for PI point datatype (AF type name)",
"ToolTipCode": "osipiweb.tagTypeFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum number of messages processed per second. Set to 0 to disable throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "description",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Description",
"LabelCode": "osipiweb.description.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "subscribeInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 3600,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Subscribe Interval (s)",
"LabelCode": "osipiweb.subscribeInterval.label",
"ToolTip": "The subscription polling interval in seconds",
"ToolTipCode": "osipiweb.subscribeInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure Skip Verify",
"LabelCode": "osipiweb.insecureSkipVerify.label",
"ToolTip": "When enabled, the server's certificate chain and host name are not verified. Use only for testing, as this removes protection against man-in-the-middle attacks.",
"ToolTipCode": "osipiweb.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "checkTags",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Check Tags",
"LabelCode": "osipiweb.checkTags.label",
"ToolTip": "Check if point name exists before attempting to create new when writing",
"ToolTipCode": "osipiweb.checkTags.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 10,
"Maximum": 30000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request Timeout (ms)",
"LabelCode": "osipiweb.requestTimeout.label",
"ToolTip": "HTTP Request Timeout in milliseconds",
"ToolTipCode": "osipiweb.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "afServer",
"Value": {
"Type": "string",
"Hidden": true,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "AssetFramework Server Name",
"LabelCode": "osipiweb.afServer.label",
"ToolTip": "Name of Asset Framework server",
"ToolTipCode": "osipiweb.afServer.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "osipiweb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "publishCountThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 50,
"Minimum": 1,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish Count Threshold",
"LabelCode": "osipiweb.countThreshold.label",
"ToolTip": "Number of messages buffered before a batch is published. Set to 1 to disable batching.",
"ToolTipCode": "osipiweb.countThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "compression",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Gzip Compression",
"LabelCode": "osipiweb.compression.label",
"ToolTip": "Enable gzip compression for OMF requests",
"ToolTipCode": "osipiweb.compression.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": true,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "osipiweb.database.label",
"ToolTip": "Name of Asset Framework database",
"ToolTipCode": "osipiweb.database.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "publishDelayThreshold",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 0,
"Maximum": 600000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Publish Delay Threshold (ms)",
"LabelCode": "osipiweb.delayThreshold.label",
"ToolTip": "Publish delay threshold in milliseconds (0 disables batching)",
"ToolTipCode": "osipiweb.delayThreshold.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tagNameFormat",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "$S$V.$D.$N",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Point Name Format",
"LabelCode": "osipiweb.tagNameFormat.label",
"ToolTip": "Formatting directives for PI point name",
"ToolTipCode": "osipiweb.tagNameFormat.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 2,
"MaxLength": 256,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"username",
"password",
"requestTimeout",
"tagNameFormat",
"tagTypeFormat",
"subscribeInterval",
"maxSubscriptionEvents",
"publishDelayThreshold",
"publishCountThreshold"
],
"Order": [
"name",
"description",
"endpoint",
"username",
"password",
"insecureSkipVerify",
"caCert",
"timezone",
"dataSourceType",
"dataSourceVersion",
"tagNameFormat",
"tagTypeFormat",
"tagDescriptionFormat",
"compression",
"checkTags",
"piServer",
"requestTimeout",
"publishDelayThreshold",
"publishCountThreshold",
"subscribeInterval",
"maxSubscriptionEvents",
"workersCount",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": null
}
}
}
Provider Schema - PostgreSQL
POST {{edgeUrl}}/cc/v2
PostgreSQL — Provider Schema
Provider ID: 7c4e5f8a-9b2d-4a3e-b1c6-8d7f9e2a5b4c
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
privateKey |
string | Private key | No | `` | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
username |
string | Username | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
hostname |
string | Hostname | Yes | - | - |
mapping |
object | Mapping | No | - | - |
schema |
string | Schema | No | - | - |
sslMode |
string | SSL Mode | No | disable |
disable, require, verify-ca, verify-full |
table |
string | Table | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
password |
string | Password | No | - | - |
certificate |
string | Certificate | No | `` | - |
createTable |
boolean | Create table | Yes | False |
- |
database |
string | Database | Yes | - | - |
enableJsonPath |
boolean | Enable JSONPath | No | False |
- |
name |
string | Name | Yes | - | - |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
port |
integer | Port | Yes | 5432 |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
batchTimeout |
integer | Batch timeout | No | 500 |
- |
caCert |
string | CA Certificate | No | `` | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "7c4e5f8a-9b2d-4a3e-b1c6-8d7f9e2a5b4c"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/postgresql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "postgresql.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert transaction may take before it is treated as failed and retried",
"ToolTipCode": "postgresql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "postgresql.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "postgresql.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "postgresql.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to commit, so this bounds how many rows a batch can collect.",
"ToolTipCode": "postgresql.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "postgresql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "postgresql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "postgresql.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "postgresql.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "postgresql.mapping.label",
"ToolTip": "Key is a column in your table. Value is a payload field name (deviceId), the matching default-schema column name (device_id), or static text prefixed with @ (@plant-a). Leave empty to use the default schema. When \"Enable JSONPath\" is on, a value starting with $ is read as a JSONPath expression instead of a field name.",
"ToolTipCode": "postgresql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "postgresql.schema.label",
"ToolTip": "Schema of the target table. Leave empty to use the database's default search path (usually public).",
"ToolTipCode": "postgresql.schema.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "disable",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "postgresql.sslmode.label",
"ToolTip": "Controls certificate validation: disable skips TLS entirely, require encrypts but skips verification, verify-ca validates the CA certificate, verify-full also validates the hostname.",
"ToolTipCode": "postgresql.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "postgresql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "postgresql.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but rows from different batches can be written out of publish order.",
"ToolTipCode": "postgresql.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "postgresql.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "postgresql.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with PostgreSQL. Paste the PEM-encoded certificate here.",
"ToolTipCode": "postgresql.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "postgresql.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "postgresql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "postgresql.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "enableJsonPath",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable JSONPath",
"LabelCode": "postgresql.enableJsonPath.label",
"ToolTip": "Read mapping values that start with $ as JSONPath expressions, so a column can be filled from a nested payload field such as $.factory.line.machine.sensors.temperature. Dotted paths, quoted keys and array indexes are supported. Values that do not start with $ keep their usual meaning, and an expression matching nothing writes NULL.",
"ToolTipCode": "postgresql.enableJsonPath.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "postgresql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "PostgreSQL",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "postgresql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "postgresql.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5432,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "postgresql.port.label",
"ToolTip": "Port of PostgreSQL host.",
"ToolTipCode": "postgresql.port.tooltip",
"Example": 5432,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "postgresql.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is committed, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "postgresql.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "postgresql.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous commit attempt before a batch that is not yet full is written",
"ToolTipCode": "postgresql.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "postgresql.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "postgresql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"username",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"sslMode",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"schema",
"table",
"mapping",
"enableJsonPath",
"createTable",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"writeMode",
"parallelTransactions",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - REST API
POST {{edgeUrl}}/cc/v2
REST API — Provider Schema
Provider ID: 3a8f7c1e-5a4c-4cf4-9b8e-7a2d0d3c1f10
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
oAuth2ClientID |
string | OAuth2 - Client ID | Yes, when authentication is oauth2_client_credentials |
- | - |
params |
object | Params | No | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
apiKeyHeader |
string | API Key Header Name | Yes, when authentication is api_key |
- | - |
clientKey |
string | Client Key (PEM) | Yes, when authentication is mtls |
`` | - |
connectionCheckingInterval |
integer | Connection Checking Interval (s) | No | 15 |
- |
insecureSkipVerify |
boolean | Insecure skip verify | No | False |
- |
oAuth2ClientSecret |
string | OAuth2 - Client Secret | Yes, when authentication is oauth2_client_credentials |
- | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
workersCount |
integer | Parallel Publish Count | No | 100 |
- |
apiKeyValue |
string | API Key Value | Yes, when authentication is api_key |
- | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
responseTopic |
string | Response Topic | No | - | - |
username |
string | Username | Yes, when authentication is basic |
- | - |
caCert |
string | CA Certificate (PEM) | No | `` | - |
clientCert |
string | Client Certificate (PEM) | Yes, when authentication is mtls |
`` | - |
password |
string | Password | Yes, when authentication is basic |
- | - |
headers |
object | Headers | No | - | - |
method |
string | HTTP Method | Yes | POST |
GET, POST, PUT, PATCH, DELETE |
persistentStorage |
boolean | Persistent storage | No | True |
- |
requestTimeout |
integer | Request Timeout (s) | No | 10 |
- |
endpoint |
string | Endpoint / Base URL | Yes | - | - |
responseMode |
string | Response Mode | No | body_only |
body_only, full_metadata |
authentication |
string | Authentication | Yes | none |
none, basic, bearer, api_key, oauth2_client_credentials, mtls |
name |
string | Name | Yes | - | - |
oAuth2Scope |
string | OAuth2 - Scope | No | - | - |
oAuth2TokenEndpoint |
string | OAuth2 - Token Endpoint | Yes, when authentication is oauth2_client_credentials |
- | - |
retryBackoff |
string | Retry Backoff | No | exponential |
none, fixed, exponential |
retryCount |
integer | Retry Count | No | 0 |
- |
bearerToken |
string | Token | Yes, when authentication is bearer |
- | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "3a8f7c1e-5a4c-4cf4-9b8e-7a2d0d3c1f10"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/rest-gen2.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "oAuth2ClientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client ID",
"LabelCode": "rest.oauth2.clientID.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"oauth2_client_credentials"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "params",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Params",
"LabelCode": "rest.params.label",
"ToolTip": "URL query string parameters",
"ToolTipCode": "rest.params.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "apiKeyHeader",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "API Key Header Name",
"LabelCode": "rest.apikey.header.label",
"ToolTip": "Header name that carries the API key",
"ToolTipCode": "rest.apikey.header.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"api_key"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "clientKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Key (PEM)",
"LabelCode": "rest.tls.clientKey.label",
"ToolTip": "Client private key for mutual TLS",
"ToolTipCode": "rest.tls.clientKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"mtls"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "connectionCheckingInterval",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 15,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection Checking Interval (s)",
"LabelCode": "rest.connectionCheckingInterval.label",
"ToolTip": "How often, in seconds, the connector checks the REST endpoint for connectivity",
"ToolTipCode": "rest.connectionCheckingInterval.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "rest.insecureSkipVerify.label",
"ToolTip": "When true, the client does not verify the server's certificate chain or host name",
"ToolTipCode": "rest.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"mtls"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "oAuth2ClientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client Secret",
"LabelCode": "rest.oauth2.clientSecret.label",
"ToolTip": "Client secret credential paired with the Client ID.",
"ToolTipCode": "rest.oauth2.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"oauth2_client_credentials"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "rest.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput and resource usage.",
"ToolTipCode": "rest.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "apiKeyValue",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "API Key Value",
"LabelCode": "rest.apikey.value.label",
"ToolTip": "Secret value sent in the header named above.",
"ToolTipCode": "rest.apikey.value.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"api_key"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "responseTopic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Response Topic",
"LabelCode": "rest.responseTopic.label",
"ToolTip": "NATS topic the response is published to",
"ToolTipCode": "rest.responseTopic.tooltip",
"Example": "/response_topic",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "rest.basic.username.label",
"ToolTip": "Username for Basic authentication",
"ToolTipCode": "rest.basic.username.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"basic"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate (PEM)",
"LabelCode": "rest.tls.caCert.label",
"ToolTip": "Optional custom CA certificate (PEM) used to verify the server",
"ToolTipCode": "rest.tls.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"mtls"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "clientCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Certificate (PEM)",
"LabelCode": "rest.tls.clientCert.label",
"ToolTip": "Client certificate for mutual TLS",
"ToolTipCode": "rest.tls.clientCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"mtls"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "rest.basic.password.label",
"ToolTip": "Password for Basic authentication",
"ToolTipCode": "rest.basic.password.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"basic"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "headers",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Headers",
"LabelCode": "rest.headers.label",
"ToolTip": "Custom HTTP headers sent with each request as key-value pairs. Example: Authorization: Bearer <token> or Content-Type: application/json.",
"ToolTipCode": "rest.headers.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "method",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "POST",
"Minimum": null,
"Maximum": null,
"Enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "HTTP Method",
"LabelCode": "rest.method.label",
"ToolTip": "HTTP verb used for every request: GET, POST, PUT, PATCH, or DELETE.",
"ToolTipCode": "rest.method.tooltip",
"Example": "POST",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request Timeout (s)",
"LabelCode": "rest.requestTimeout.label",
"ToolTip": "Per-request timeout in seconds",
"ToolTipCode": "rest.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint / Base URL",
"LabelCode": "rest.endpoint.label",
"ToolTip": "Target REST endpoint, e.g. https://api.example.com",
"ToolTipCode": "rest.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "responseMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "body_only",
"Minimum": null,
"Maximum": null,
"Enum": [
"body_only",
"full_metadata"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Response Mode",
"LabelCode": "rest.responseMode.label",
"ToolTip": "body_only publishes correlationId+statusCode+body; full_metadata also includes headers, latencyMs, and error",
"ToolTipCode": "rest.responseMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authentication",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "none",
"Minimum": null,
"Maximum": null,
"Enum": [
"none",
"basic",
"bearer",
"api_key",
"oauth2_client_credentials",
"mtls"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Authentication",
"LabelCode": "rest.auth.label",
"ToolTip": "Scheme used to authenticate to the endpoint. Selecting a mode reveals the credential fields it needs.",
"ToolTipCode": "rest.auth.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "rest.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2Scope",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Scope",
"LabelCode": "rest.oauth2.scope.label",
"ToolTip": "OAuth2 scope (comma separated)",
"ToolTipCode": "rest.oauth2.scope.tooltip",
"Example": "view,read",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"oauth2_client_credentials"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "oAuth2TokenEndpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Token Endpoint",
"LabelCode": "rest.oauth2.tokenEndpoint.label",
"ToolTip": "OAuth2 token endpoint URL",
"ToolTipCode": "rest.oauth2.tokenEndpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"oauth2_client_credentials"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "retryBackoff",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "exponential",
"Minimum": null,
"Maximum": null,
"Enum": [
"none",
"fixed",
"exponential"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Retry Backoff",
"LabelCode": "rest.retryBackoff.label",
"ToolTip": "Retry backoff strategy. Retry-After is honored on 429.",
"ToolTipCode": "rest.retryBackoff.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "retryCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 10,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Retry Count",
"LabelCode": "rest.retryCount.label",
"ToolTip": "Maximum number of retries on transport errors, 5xx, or 429",
"ToolTipCode": "rest.retryCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bearerToken",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Token",
"LabelCode": "rest.bearer.token.label",
"ToolTip": "Sent as Authorization: Bearer <token>",
"ToolTipCode": "rest.bearer.token.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authentication",
"FieldValues": [
"bearer"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
}
],
"OneOf": [
{
"Required": [
"name",
"endpoint",
"method",
"authentication"
],
"Order": [
"name",
"endpoint",
"method",
"authentication",
"username",
"password",
"bearerToken",
"apiKeyHeader",
"apiKeyValue",
"oAuth2TokenEndpoint",
"oAuth2ClientID",
"oAuth2ClientSecret",
"oAuth2Scope",
"caCert",
"clientCert",
"clientKey",
"insecureSkipVerify",
"headers",
"params",
"responseTopic",
"responseMode",
"workersCount",
"requestTimeout",
"retryCount",
"retryBackoff",
"connectionCheckingInterval",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - REST API (Gen 1)
POST {{edgeUrl}}/cc/v2
REST API (Gen 1) — Provider Schema
Provider ID: 1532a2b5-590f-43d3-9faf-35df646890de
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
requestTimeout |
integer | Request timeout | No | 10 |
- |
endpoint |
string | Endpoint | Yes | - | - |
insecureSkipVerify |
boolean | Insecure skip verify | No | True |
- |
oAuth2ClientID |
string | OAuth2 - Client ID | No | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
method |
string | Method | Yes | POST |
GET, POST, PUT, DELETE |
oAuth2ClientSecret |
string | OAuth2 - Client Secret | No | - | - |
params |
object | Params | No | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
mapping |
object | Mapping | No | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
workersCount |
integer | Parallel Publish Count | Yes | 100 |
- |
headers |
object | Headers | No | - | - |
name |
string | Name | Yes | - | - |
oAuth2Scope |
string | OAuth2 - Scope | No | - | - |
oAuth2TokenEndpoint |
string | OAuth2 - Token Endpoint | No | - | - |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "1532a2b5-590f-43d3-9faf-35df646890de"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/rest.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "requestTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 60,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request timeout",
"LabelCode": "rest.requestTimeout.label",
"ToolTip": "Maximum time in seconds to wait for a response before the request is abandoned.",
"ToolTipCode": "rest.requestTimeout.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "endpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "rest.endpoint.label",
"ToolTip": "Full URL of the REST API endpoint to send requests to (e.g. https://api.example.com/data).",
"ToolTipCode": "rest.endpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "insecureSkipVerify",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Insecure skip verify",
"LabelCode": "rest.insecureSkipVerify.label",
"ToolTip": "When enabled, the server's certificate chain and host name are not verified. Use only for testing, as this removes protection against man-in-the-middle attacks.",
"ToolTipCode": "rest.insecureSkipVerify.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2ClientID",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client ID",
"LabelCode": "rest.oauth2.clientID.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "method",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "POST",
"Minimum": null,
"Maximum": null,
"Enum": [
"GET",
"POST",
"PUT",
"DELETE"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Method",
"LabelCode": "rest.method.label",
"ToolTip": "HTTP method used for each request. Use POST for data submission; GET, PUT, DELETE for specific REST operations.",
"ToolTipCode": "rest.method.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2ClientSecret",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Client Secret",
"LabelCode": "rest.oauth2.clientSecret.label",
"ToolTip": "OAuth2 client secret credential paired with the Client ID. Authorizes token requests to the identity provider.",
"ToolTipCode": "rest.oauth2.clientSecret.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "params",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Params",
"LabelCode": "rest.params.label",
"ToolTip": "URL query parameters appended to the endpoint on each request as key-value pairs.",
"ToolTipCode": "rest.params.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "rest.mapping.label",
"ToolTip": "Maps incoming message field names to REST API body field names. Leave empty to forward fields unchanged.",
"ToolTipCode": "rest.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 100,
"Minimum": 10,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "rest.workersCount.label",
"ToolTip": "Number of messages published in parallel. Higher values increase throughput but can overflow the broker's queue and drop messages.",
"ToolTipCode": "rest.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "headers",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Headers",
"LabelCode": "rest.headers.label",
"ToolTip": "Custom HTTP headers sent with each request as key-value pairs. Example: Content-Type: application/json.",
"ToolTipCode": "rest.headers.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "rest.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2Scope",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Scope",
"LabelCode": "rest.oauth2.scope.label",
"ToolTip": "Comma-separated OAuth2 scopes requested when obtaining an access token.",
"ToolTipCode": "rest.oauth2.scope.tooltip",
"Example": "view,read",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "oAuth2TokenEndpoint",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "OAuth2 - Token Endpoint",
"LabelCode": "rest.oauth2.tokenEndpoint.label",
"ToolTip": "URL of the identity provider's token endpoint used to obtain OAuth2 access tokens.",
"ToolTipCode": "rest.oauth2.tokenEndpoint.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"method",
"endpoint",
"workersCount"
],
"Order": [
"name",
"method",
"endpoint",
"headers",
"params",
"mapping",
"requestTimeout",
"insecureSkipVerify",
"workersCount",
"oAuth2TokenEndpoint",
"oAuth2ClientSecret",
"oAuth2ClientID",
"oAuth2Scope",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - SAP Hana Cloud
POST {{edgeUrl}}/cc/v2
SAP Hana Cloud — Provider Schema
Provider ID: 0f3b6c4a-5d2e-4a71-9c8f-1e6b2d40a973
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
port |
integer | Port | Yes | 443 |
- |
hostname |
string | Hostname | Yes | - | - |
tlsMode |
string | TLS mode | No | verify-full |
disable, require, verify-full |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
password |
string | Password | Yes, when authMethod is password |
- | - |
table |
string | Table | Yes | - | - |
username |
string | Username | Yes, when authMethod is password |
- | - |
clientKey |
string | Client Private Key | Yes, when authMethod is x509 |
`` | - |
schema |
string | Schema | No | `` | - |
authMethod |
string | Authentication method | No | password |
password, x509 |
connectionTimeout |
integer | Connection timeout (seconds) | No | 10 |
- |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
caCert |
string | CA Certificate | No | `` | - |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
createTable |
boolean | Create table | Yes | False |
- |
databaseName |
string | Tenant database | No | `` | - |
mapping |
object | Mapping | No | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
tlsServerName |
string | TLS server name | No | `` | - |
allowDmlOnExecuteCommand |
boolean | Allow data modification via Execute Command | No | False |
- |
batchTimeout |
integer | Batch timeout | No | 500 |
- |
clientCert |
string | Client Certificate | Yes, when authMethod is x509 |
`` | - |
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "0f3b6c4a-5d2e-4a71-9c8f-1e6b2d40a973"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/saphanacloudsql.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 443,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "saphanacloudsql.port.label",
"ToolTip": "SQL endpoint port. SAP HANA Cloud listens on 443; on-premise systems use 3<instance-nr>15, for example 30015.",
"ToolTipCode": "saphanacloudsql.port.tooltip",
"Example": 443,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "saphanacloudsql.hostname.label",
"ToolTip": "DNS name or IP of the SQL endpoint, for example <instance-id>.hana.<region>.hanacloud.ondemand.com.",
"ToolTipCode": "saphanacloudsql.hostname.tooltip",
"Example": "abcd1234-5678-90ef-ghij-klmnopqrstuv.hana.eu10.hanacloud.ondemand.com",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tlsMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "verify-full",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"require",
"verify-full"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "TLS mode",
"LabelCode": "saphanacloudsql.tlsMode.label",
"ToolTip": "disable connects in cleartext and only works against on-premise systems. require encrypts without checking the server certificate. verify-full encrypts and validates the certificate chain and host name.",
"ToolTipCode": "saphanacloudsql.tlsMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "saphanacloudsql.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "saphanacloudsql.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "saphanacloudsql.password.label",
"ToolTip": "Password for the database user. Required for password authentication and ignored for x509.",
"ToolTipCode": "saphanacloudsql.password.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authMethod",
"FieldValues": [
"password"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "saphanacloudsql.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected schema unless \"Create Table\" is enabled. SAP HANA stores unquoted identifiers in upper case, so enter MYTABLE unless the table was created with a quoted lower-case name.",
"ToolTipCode": "saphanacloudsql.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "saphanacloudsql.username.label",
"ToolTip": "Database user. Required for password authentication and ignored for x509.",
"ToolTipCode": "saphanacloudsql.username.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authMethod",
"FieldValues": [
"password"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "clientKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Private Key",
"LabelCode": "saphanacloudsql.clientKey.label",
"ToolTip": "PEM private key matching the client certificate. Must not be password encrypted.",
"ToolTipCode": "saphanacloudsql.clientKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authMethod",
"FieldValues": [
"x509"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "saphanacloudsql.schema.label",
"ToolTip": "Schema holding the target table. Leave empty to use the connecting user's CURRENT_SCHEMA. SAP HANA stores unquoted identifiers in upper case, so enter MYSCHEMA unless the schema was created with a quoted lower-case name.",
"ToolTipCode": "saphanacloudsql.schema.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "authMethod",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "password",
"Minimum": null,
"Maximum": null,
"Enum": [
"password",
"x509"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Authentication method",
"LabelCode": "saphanacloudsql.authMethod.label",
"ToolTip": "password authenticates with a database user name and password. x509 authenticates with a client certificate; the database user is then derived server-side from the certificate mapping.",
"ToolTipCode": "saphanacloudsql.authMethod.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "connectionTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 10,
"Minimum": 1,
"Maximum": 300,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Connection timeout (seconds)",
"LabelCode": "saphanacloudsql.connection_timeout.label",
"ToolTip": "Seconds to wait for one connection attempt: the login handshake, the CURRENT_SCHEMA lookup, and each liveness check. Raise it for an instance reached over a slow or congested link. Note this field is in seconds, while Commit timeout is in milliseconds.",
"ToolTipCode": "saphanacloudsql.connection_timeout.tooltip",
"Example": 10,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "saphanacloudsql.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "SAP Hana Cloud",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "saphanacloudsql.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "saphanacloudsql.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to commit, so this bounds how many rows a batch can collect.",
"ToolTipCode": "saphanacloudsql.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "saphanacloudsql.caCert.label",
"ToolTip": "CA certificate used to validate the server. Leave empty to trust the system certificate store, which already covers SAP HANA Cloud.",
"ToolTipCode": "saphanacloudsql.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "tlsMode",
"FieldValues": [
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "saphanacloudsql.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but rows from different batches can be written out of publish order.",
"ToolTipCode": "saphanacloudsql.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "saphanacloudsql.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is committed, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "saphanacloudsql.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "saphanacloudsql.createTable.label",
"ToolTip": "Create the table with the default layout if it does not exist. The database user needs CREATE TABLE permission on the schema.",
"ToolTipCode": "saphanacloudsql.createTable.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "databaseName",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Tenant database",
"LabelCode": "saphanacloudsql.databaseName.label",
"ToolTip": "Tenant database to redirect to on a multi-tenant system. Leave empty for SAP HANA Cloud, where the SQL endpoint already addresses the database.",
"ToolTipCode": "saphanacloudsql.databaseName.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "saphanacloudsql.mapping.label",
"ToolTip": "Key is a column in your table. Value is a payload field name (deviceId), the matching default-schema column name (device_id), or static text prefixed with @ (@plant-a). Leave empty to use the default table layout.",
"ToolTipCode": "saphanacloudsql.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tlsServerName",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "TLS server name",
"LabelCode": "saphanacloudsql.tlsServerName.label",
"ToolTip": "Overrides the host name checked against the server certificate. Needed when the instance is reached through an IP address or a forwarding proxy.",
"ToolTipCode": "saphanacloudsql.tlsServerName.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "tlsMode",
"FieldValues": [
"require",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "allowDmlOnExecuteCommand",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Allow data modification via Execute Command",
"LabelCode": "saphanacloudsql.allow_dml_on_execute_command.label",
"ToolTip": "When disabled, Execute Command accepts only SELECT and WITH; INSERT, UPDATE, DELETE, MERGE, TRUNCATE, DDL, GRANT and CALL are rejected before reaching the database. Enable this only if you intend to modify data through Execute Command, and note that doing so is your responsibility: the statement is run as supplied, with no validation beyond its leading keyword, and Execute Command cannot report how many rows changed - a committed UPDATE returns \"OK\" with 0 rows, exactly like a SELECT that matched nothing. The database user's own privileges remain the only limit on what a statement can do.",
"ToolTipCode": "saphanacloudsql.allow_dml_on_execute_command.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "saphanacloudsql.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous commit attempt before a batch that is not yet full is written",
"ToolTipCode": "saphanacloudsql.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "clientCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Client Certificate",
"LabelCode": "saphanacloudsql.clientCert.label",
"ToolTip": "PEM client certificate presented for x509 authentication. Its subject must be mapped to a database user on the instance.",
"ToolTipCode": "saphanacloudsql.clientCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "authMethod",
"FieldValues": [
"x509"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "saphanacloudsql.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert transaction may take before it is treated as failed and retried",
"ToolTipCode": "saphanacloudsql.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"authMethod",
"username",
"password",
"clientCert",
"clientKey",
"tlsMode",
"caCert",
"tlsServerName",
"databaseName",
"connectionTimeout",
"schema",
"table",
"mapping",
"createTable",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"writeMode",
"parallelTransactions",
"workersCount",
"allowDmlOnExecuteCommand",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Snowflake Snowpipe Stream
POST {{edgeUrl}}/cc/v2
Snowflake Snowpipe Stream — Provider Schema
Provider ID: acbc4d51-d2e9-4370-bb7a-3d894d7ec24c
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
privateKeyPassphrase |
string | Private Key Passphrase | No | - | - |
database |
string | Database | Yes | - | - |
name |
string | Name | Yes | - | - |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
schema |
string | Schema | Yes | - | - |
username |
string | Username | Yes | - | - |
account |
string | Account | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
privateKey |
string | Private key | Yes | `` | - |
requestTimeoutSec |
integer | Request Timeout (sec) | No | 30 |
- |
tableName |
string | Table Name | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "acbc4d51-d2e9-4370-bb7a-3d894d7ec24c"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/snowflake-snowpipe-stream.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "privateKeyPassphrase",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Private Key Passphrase",
"LabelCode": "snowflakeSnowpipeStream.privateKeyPassphrase.label",
"ToolTip": "Passphrase for the encrypted private key. Leave empty if the private key is not encrypted.",
"ToolTipCode": "snowflakeSnowpipeStream.privateKeyPassphrase.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "snowflakeSnowpipeStream.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "mydb",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "snowflakeSnowpipeStream.name.label",
"ToolTip": "User defined name of connector instance",
"ToolTipCode": "snowflakeSnowpipeStream.name.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "snowflakeSnowpipeStream.schema.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "myschema",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "snowflakeSnowpipeStream.username.label",
"ToolTip": "Snowflake username used for key-pair authentication",
"ToolTipCode": "snowflakeSnowpipeStream.username.tooltip",
"Example": "my_user",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "account",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Account",
"LabelCode": "snowflakeSnowpipeStream.account.label",
"ToolTip": "Snowflake account identifier (e.g. xy12345.us-east-1)",
"ToolTipCode": "snowflakeSnowpipeStream.account.tooltip",
"Example": "xy12345.us-east-1",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "snowflakeSnowpipeStream.privateKey.label",
"ToolTip": "PEM-encoded RSA private key for JWT authentication with the Snowflake Snowpipe REST API",
"ToolTipCode": "snowflakeSnowpipeStream.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "requestTimeoutSec",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Request Timeout (sec)",
"LabelCode": "snowflakeSnowpipeStream.requestTimeoutSec.label",
"ToolTip": "HTTP request timeout in seconds for Snowpipe REST API calls",
"ToolTipCode": "snowflakeSnowpipeStream.requestTimeoutSec.tooltip",
"Example": 30,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "tableName",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table Name",
"LabelCode": "snowflakeSnowpipeStream.tableName.label",
"ToolTip": "Snowflake table data will be streamed into. The table must exist before data can be ingested.",
"ToolTipCode": "snowflakeSnowpipeStream.tableName.tooltip",
"Example": "mytable",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"account",
"username",
"privateKey",
"database",
"schema",
"tableName"
],
"Order": [
"name",
"account",
"username",
"privateKey",
"privateKeyPassphrase",
"database",
"schema",
"tableName",
"requestTimeoutSec",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Splunk
POST {{edgeUrl}}/cc/v2
Splunk — Provider Schema
Provider ID: c3e1cdf0-7824-42a6-880f-e54d47d6041f
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
token |
string | Token | Yes | - | - |
useSSL |
boolean | Use SSL | Yes | True |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 8088 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
topic |
string | Endpoint | Yes | services/collector/event |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "c3e1cdf0-7824-42a6-880f-e54d47d6041f"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/splunk.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "splunk.hostname.label",
"ToolTip": "Splunk server host name",
"ToolTipCode": "splunk.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "splunk.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "Splunk",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Token",
"LabelCode": "splunk.token.label",
"ToolTip": "HEC token for access to the Splunk server",
"ToolTipCode": "splunk.token.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "useSSL",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Use SSL",
"LabelCode": "splunk.usessl.label",
"ToolTip": "Use an HTTPS connection to the Splunk HEC endpoint",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8088,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "splunk.port.label",
"ToolTip": "Port of the Splunk HEC host",
"ToolTipCode": "splunk.port.tooltip",
"Example": "8088",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "services/collector/event",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "splunk.topic.label",
"ToolTip": "Splunk HEC endpoint path",
"ToolTipCode": "splunk.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"useSSL",
"hostname",
"port",
"topic",
"token"
],
"Order": [
"name",
"hostname",
"port",
"useSSL",
"topic",
"token",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - Splunk (Gen 1)
POST {{edgeUrl}}/cc/v2
Splunk (Gen 1) — Provider Schema
Provider ID: aa1886dd-260d-4aad-b0d1-b9c49e814956
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
hostname |
string | Hostname | Yes | - | - |
name |
string | Name | Yes | - | - |
persistentStorage |
boolean | Persistent storage | No | True |
- |
port |
integer | Port | Yes | 8088 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
token |
string | Token | Yes | - | - |
workersCount |
integer | Parallel Publish Count | No | 1 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
topic |
string | Endpoint | Yes | services/collector/event |
- |
useSSL |
boolean | Use SSL | Yes | True |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "aa1886dd-260d-4aad-b0d1-b9c49e814956"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/splunk.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "splunk.hostname.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "splunk.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 8088,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "splunk.port.label",
"ToolTip": "Port of splunk host.",
"ToolTipCode": "splunk.port.tooltip",
"Example": "8088",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "token",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Token",
"LabelCode": "splunk.token.label",
"ToolTip": "Splunk HTTP Event Collector (HEC) token used to authenticate data submissions. Generate in Splunk under Settings > Data Inputs > HTTP Event Collector.",
"ToolTipCode": "splunk.token.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "The number of simultaneously publishing messages",
"ToolTipCode": "generic.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "topic",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "services/collector/event",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Endpoint",
"LabelCode": "splunk.topic.label",
"ToolTip": "Splunk HTTP Event Collector endpoint path. Default is services/collector/event for JSON events.",
"ToolTipCode": "splunk.topic.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "useSSL",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Use SSL",
"LabelCode": "splunk.usessl.label",
"ToolTip": "Enable HTTPS/TLS for the connection to the Splunk HEC endpoint. Recommended in all production environments.",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"useSSL",
"hostname",
"port",
"topic",
"token"
],
"Order": [
"name",
"hostname",
"port",
"useSSL",
"topic",
"token",
"workersCount",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}
Provider Schema - TimescaleDB
POST {{edgeUrl}}/cc/v2
TimescaleDB — Provider Schema
Provider ID: 2afd221e-1538-4eae-85a0-a7ce76e2368c
| Field | Type | Label | Required | Default | Options |
|---|---|---|---|---|---|
minConns |
integer | Min pool connections | No | 0 |
- |
plSizeLimitGB |
integer | Persistent storage size limit | No | 1 |
- |
username |
string | Username | No | - | - |
certificate |
string | Certificate | No | `` | - |
name |
string | Name | Yes | - | - |
parallelTransactions |
integer | Parallel transactions | No | 1 |
- |
persistentStorage |
boolean | Persistent storage | No | True |
- |
writeMode |
string | Write mode | No | sync |
sync, async |
maxConnIdleTime |
integer | Max connection idle time (seconds) | No | 0 |
- |
privateKey |
string | Private key | No | `` | - |
workersCount |
integer | Parallel Publish Count | No | 1000 |
- |
batchTimeout |
integer | Batch timeout | No | 500 |
- |
enableJsonPath |
boolean | Enable JSONPath | No | False |
- |
maxConns |
integer | Max pool connections | No | 0 |
- |
port |
integer | Port | Yes | 5432 |
- |
bulkSize |
integer | Bulk insert count | No | 0 |
- |
queueMode |
string | Queue Mode | No | lifo |
lifo, fifo |
schema |
string | Schema | No | - | - |
commitTimeout |
integer | Commit timeout | No | 30000 |
- |
mapping |
object | Mapping | No | - | - |
maxConnLifetime |
integer | Max connection lifetime (seconds) | No | 0 |
- |
password |
string | Password | No | - | - |
caCert |
string | CA Certificate | No | `` | - |
database |
string | Database | Yes | - | - |
hostname |
string | Hostname | Yes | - | - |
sslMode |
string | SSL Mode | No | disable |
disable, require, verify-ca, verify-full |
table |
string | Table | Yes | - | - |
throttlingLimit |
integer | Throttling limit | No | 0 |
- |
createTable |
boolean | Create table | Yes | False |
- |
maxTransactionSize |
integer | Max transaction size | No | 500 |
- |
Request Body
GraphQL Query
query GetProviderSchema($input: GetProviderInfoRequest!) {
GetProviderSchema(input: $input) {
ID
Schema
Type
Properties {
Key
Value {
Type
Hidden
Default
Minimum
Maximum
Enum
Protected
FieldType
MaskedType
ReadOnly
Advanced
Label
LabelCode
ToolTip
ToolTipCode
Example
Multiline
AllowUpload
AllowEmpty
Required
MinLength
MaxLength
ControllerFieldId
LinkedFields {
FieldName
FieldValues
Criteria
GroupNumber
}
}
}
OneOf {
Required
Order
}
LimitDataDirectionScope
}
}
Variables
{
"input": {
"ProviderID": "2afd221e-1538-4eae-85a0-a7ce76e2368c"
}
}
Response
Status: 200 OK
{
"data": {
"GetProviderSchema": {
"ID": "http://litmusautomation.com/schemas/cc/timescaledb.json",
"Schema": "http://json-schema.org/draft-07/schema#",
"Type": "object",
"Properties": [
{
"Key": "minConns",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Min pool connections",
"LabelCode": "timescaledb.min_conns.label",
"ToolTip": "Minimum idle connections kept in the pgx pool. 0 uses pgx's default (0). Must be <= maxConns when both are set.",
"ToolTipCode": "timescaledb.min_conns.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "plSizeLimitGB",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitGB.label",
"ToolTip": "Persistent storage size limit in GB",
"ToolTipCode": "generic.plSizeLimitGB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "plSizeLimitMB",
"Value": {
"Type": "integer",
"Hidden": true,
"Default": 1024,
"Minimum": 1,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage size limit",
"LabelCode": "generic.plSizeLimitMB.label",
"ToolTip": "Deprecated. Replaced by the persistent storage size limit in GB; retained only so existing configurations keep working.",
"ToolTipCode": "generic.plSizeLimitMB.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "username",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Username",
"LabelCode": "timescaledb.username.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "certificate",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Certificate",
"LabelCode": "timescaledb.certificate.label",
"ToolTip": "Client certificate for mutual TLS authentication with TimescaleDB. Paste the PEM-encoded certificate here.",
"ToolTipCode": "timescaledb.certificate.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "name",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Name",
"LabelCode": "timescaledb.name.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": "TimescaleDB",
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "parallelTransactions",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1,
"Minimum": 1,
"Maximum": 64,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel transactions",
"LabelCode": "timescaledb.parallelTransactions.label",
"ToolTip": "Maximum number of batch inserts running at the same time, each on its own database connection. Values above 1 raise throughput, but rows from different batches can be written out of publish order. The pool is raised to at least this value plus one, above Max pool connections if needed.",
"ToolTipCode": "timescaledb.parallelTransactions.tooltip",
"Example": 1,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "persistentStorage",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": true,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Persistent storage",
"LabelCode": "generic.persistentStorage.label",
"ToolTip": "Buffer undelivered messages on disk so they survive a restart or a loss of connection. When off, messages are held in memory only and are lost if the connector stops.",
"ToolTipCode": "generic.persistentStorage.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "writeMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "sync",
"Minimum": null,
"Maximum": null,
"Enum": [
"sync",
"async"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Write mode",
"LabelCode": "timescaledb.writeMode.label",
"ToolTip": "sync: a message is acknowledged only after its batch is committed, so with persistent storage on a failed write is kept and retried. async: a message is acknowledged once buffered, for higher throughput; a batch that fails to write is dropped.",
"ToolTipCode": "timescaledb.writeMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxConnIdleTime",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 86400,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max connection idle time (seconds)",
"LabelCode": "timescaledb.max_conn_idle_time.label",
"ToolTip": "Idle timeout for pooled connections, in seconds; idle connections older than this are closed. Range 0 (use pgx default of 1800 = 30 minutes) to 86400 (24 hours).",
"ToolTipCode": "timescaledb.max_conn_idle_time.tooltip",
"Example": 1800,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "privateKey",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "Private key",
"LabelCode": "timescaledb.privateKey.label",
"ToolTip": "Private key corresponding to the client certificate. Must match the certificate provided above.",
"ToolTipCode": "timescaledb.privateKey.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "workersCount",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 1000,
"Minimum": 1,
"Maximum": 4000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Parallel Publish Count",
"LabelCode": "generic.workersCount.label",
"ToolTip": "Number of messages published in parallel. In sync write mode each one waits for its batch to commit, so this bounds how many rows a batch can collect.",
"ToolTipCode": "timescaledb.workersCount.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "batchTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Batch timeout",
"LabelCode": "timescaledb.batchTimeout.label",
"ToolTip": "Maximum time (ms) after the previous commit attempt before a batch that is not yet full is written",
"ToolTipCode": "timescaledb.batchTimeout.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "enableJsonPath",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Enable JSONPath",
"LabelCode": "timescaledb.enableJsonPath.label",
"ToolTip": "Read mapping values that start with $ as JSONPath expressions, so a column can be filled from a nested payload field such as $.factory.line.machine.sensors.temperature. Dotted paths, quoted keys and array indexes are supported. Values that do not start with $ keep their usual meaning, and an expression matching nothing writes NULL.",
"ToolTipCode": "timescaledb.enableJsonPath.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxConns",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 1000,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max pool connections",
"LabelCode": "timescaledb.max_conns.label",
"ToolTip": "Maximum connections in the pgx pool. 0 uses pgx's default (max(4, CPU count)). Bounded by the server's max_connections (PostgreSQL default 100); consider PgBouncer above ~500.",
"ToolTipCode": "timescaledb.max_conns.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "port",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 5432,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Port",
"LabelCode": "timescaledb.port.label",
"ToolTip": "Port of TimescaleDB host.",
"ToolTipCode": "timescaledb.port.tooltip",
"Example": 5432,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "bulkSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Bulk insert count",
"LabelCode": "timescaledb.bulk_size.label",
"ToolTip": "Buffer messages and perform bulk insert once the Bulk insert count is reached",
"ToolTipCode": "timescaledb.bulk_size.tooltip",
"Example": 0,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "queueMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "lifo",
"Minimum": null,
"Maximum": null,
"Enum": [
"lifo",
"fifo"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Queue Mode",
"LabelCode": "generic.queueMode.label",
"ToolTip": "Order in which buffered messages are sent once the connection is restored. LIFO sends the newest data first; FIFO preserves the original order.",
"ToolTipCode": "generic.queueMode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": "persistentStorage",
"LinkedFields": null
}
},
{
"Key": "schema",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Schema",
"LabelCode": "timescaledb.schema.label",
"ToolTip": "Schema of the target table. Leave empty to use the database's default search path (usually public).",
"ToolTipCode": "timescaledb.schema.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "commitTimeout",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 30000,
"Minimum": 10,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Commit timeout",
"LabelCode": "timescaledb.commit_timeout.label",
"ToolTip": "Maximum time (ms) one batch insert transaction may take before it is treated as failed and retried",
"ToolTipCode": "timescaledb.commit_timeout.tooltip",
"Example": 1000,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "mapping",
"Value": {
"Type": "object",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": "kv",
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Mapping",
"LabelCode": "timescaledb.mapping.label",
"ToolTip": "Key is a column in your table. Value is a payload field name (deviceId), the matching default-schema column name (device_id), or static text prefixed with @ (@plant-a). Leave empty to use the default schema. When \"Enable JSONPath\" is on, a value starting with $ is read as a JSONPath expression instead of a field name.",
"ToolTipCode": "timescaledb.mapping.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxConnLifetime",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": 86400,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": true,
"Label": "Max connection lifetime (seconds)",
"LabelCode": "timescaledb.max_conn_lifetime.label",
"ToolTip": "Maximum lifetime of a pooled connection, in seconds; connections older than this are recycled on next release. Range 0 (use pgx default of 3600 = 1 hour) to 86400 (24 hours).",
"ToolTipCode": "timescaledb.max_conn_lifetime.tooltip",
"Example": 3600,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "password",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "password",
"MaskedType": "dotted",
"ReadOnly": null,
"Advanced": null,
"Label": "Password",
"LabelCode": "timescaledb.password.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "caCert",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "",
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": true,
"FieldType": "certificate",
"MaskedType": "protected",
"ReadOnly": null,
"Advanced": null,
"Label": "CA Certificate",
"LabelCode": "timescaledb.caCert.label",
"ToolTip": "CA certificate can be added here. It can also be added to system wide certificate list.",
"ToolTipCode": "timescaledb.caCert.tooltip",
"Example": null,
"Multiline": true,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": [
{
"FieldName": "sslMode",
"FieldValues": [
"require",
"verify-ca",
"verify-full"
],
"Criteria": "NONE",
"GroupNumber": 0
}
]
}
},
{
"Key": "database",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Database",
"LabelCode": "timescaledb.database.label",
"ToolTip": "",
"ToolTipCode": "",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "hostname",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Hostname",
"LabelCode": "timescaledb.hostname.label",
"ToolTip": "DNS name or IP of the host.",
"ToolTipCode": "timescaledb.hostname.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 3,
"MaxLength": 255,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "sslMode",
"Value": {
"Type": "string",
"Hidden": null,
"Default": "disable",
"Minimum": null,
"Maximum": null,
"Enum": [
"disable",
"require",
"verify-ca",
"verify-full"
],
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "SSL Mode",
"LabelCode": "timescaledb.sslmode.label",
"ToolTip": "Controls certificate validation: disable skips TLS entirely, require encrypts but skips verification, verify-ca validates the CA certificate, verify-full also validates the hostname.",
"ToolTipCode": "timescaledb.sslmode.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "table",
"Value": {
"Type": "string",
"Hidden": null,
"Default": null,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Table",
"LabelCode": "timescaledb.table.label",
"ToolTip": "Target table to write data into. Must exist in the selected database unless \"Create Table\" is enabled.",
"ToolTipCode": "timescaledb.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": 1,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "throttlingLimit",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 0,
"Minimum": 0,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Throttling limit",
"LabelCode": "generic.throttlingLimit.label",
"ToolTip": "Maximum outbound messages per second. 0 disables throttling.",
"ToolTipCode": "generic.throttlingLimit.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "createTable",
"Value": {
"Type": "boolean",
"Hidden": null,
"Default": false,
"Minimum": null,
"Maximum": null,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Create table",
"LabelCode": "timescaledb.createTable.label",
"ToolTip": "Create the table if it doesn't exist. To do this you need permissions.",
"ToolTipCode": "timescaledb.table.tooltip",
"Example": null,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": true,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
},
{
"Key": "maxTransactionSize",
"Value": {
"Type": "integer",
"Hidden": null,
"Default": 500,
"Minimum": 1,
"Maximum": 65535,
"Enum": null,
"Protected": null,
"FieldType": null,
"MaskedType": null,
"ReadOnly": null,
"Advanced": null,
"Label": "Max transaction size",
"LabelCode": "timescaledb.max_transaction_size.label",
"ToolTip": "Maximum number of messages before a transaction is committed regardless of timeout",
"ToolTipCode": "timescaledb.max_transaction_size.tooltip",
"Example": 500,
"Multiline": null,
"AllowUpload": null,
"AllowEmpty": null,
"Required": null,
"MinLength": null,
"MaxLength": null,
"ControllerFieldId": null,
"LinkedFields": null
}
}
],
"OneOf": [
{
"Required": [
"name",
"hostname",
"port",
"database",
"table",
"createTable"
],
"Order": [
"name",
"hostname",
"port",
"sslMode",
"caCert",
"certificate",
"privateKey",
"username",
"password",
"database",
"schema",
"table",
"mapping",
"enableJsonPath",
"createTable",
"commitTimeout",
"batchTimeout",
"maxTransactionSize",
"bulkSize",
"writeMode",
"parallelTransactions",
"workersCount",
"maxConns",
"minConns",
"maxConnLifetime",
"maxConnIdleTime",
"throttlingLimit",
"persistentStorage",
"queueMode",
"plSizeLimitMB",
"plSizeLimitGB"
]
}
],
"LimitDataDirectionScope": "OUTBOUND"
}
}
}