• Authentication
• mqtt
  • getGet MQTT client configuration.
  • postCreate a MQTT client configuration.
  • putEdit MQTT client configuration.
  • deldelete MQTT client configuration.
  • deldelete certficate.
  • getget store and forward setting.
  • putupdate store and forward setting.
  • getget message groups setting.
  • postcreate a message group.
  • getget message group setting.
  • putupdate message group setting.
  • deldelete message group setting.
  • puttest custom payload.
• azure_device
  • getGet azure iot device configuration.
  • putUpdate provisioning configuration.
  • postSetup x509 certificates.
  • getget twin properties setting.
  • putupdate twin properties setting.
  • putreported twin properties.
  • putclear twin properties.
  • getget store and forward setting.
  • putupdate store and forward setting.
  • getget message groups setting.
  • postcreate a message group.
  • getget message group setting.
  • putupdate message group setting.
  • deldelete message group setting.
  • puttest custom payload.
• aws
  • getGet AWS iot device configuration.
  • putUpdate provisioning configuration.
  • getget shadow properties setting.
  • putupdate shadow properties setting.
  • putreported shadow properties.
  • putclear shadow properties.
  • getget store and forward setting.
  • putupdate store and forward setting.
  • getget message groups setting.
  • postcreate a message group.
  • getget message group setting.
  • putupdate message group setting.
  • deldelete message group setting.
  • puttest custom payload.
• azure_iotedge
  • getGet azure iotedge configuration.
  • patchUpdate azure iotedge configuration.
  • putReset AIE APP(include iotedge runtime pkgs).
  • putControl azure iotedge service.
  • putRestart azure module.
  • postImport user certificates and update azure iotedge
  • getget twin properties setting.
  • putupdate twin properties setting.
  • putreported twin properties.
  • putclear twin properties.
  • getget message groups setting.
  • postcreate a message group.
  • getget message group setting.
  • putupdate message group setting.
  • deldelete message group setting.
  • puttest custom payload.
• sparkplug
  • getGet Sparkplug configuration.
  • putUpdate Sparkplug configuration.(BrokerList is read
  • getDownload configurations
  • putUpload configurations
  • getGet Sparkplug brokers configuration.
  • putUpdate Sparkplug brokers configuration.
  • postCreate a new Sparkplug broker configuration.
  • putUpdate Sparkplug broker configuration.
  • delDelete Sparkplug broker configuration.
  • putreported node properties.
  • getget store and forward setting.
  • putupdate store and forward setting.
  • getget message groups setting.
  • postcreate a message group.
  • getget message group setting.
  • putupdate message group setting.
  • deldelete message group setting.

Documentation Powered by Redocly

ThingsPro Cloud APIs (2.2.0)

Download OpenAPI specification:Download

ThingsPro Cloud APIs

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

mqtt

Get MQTT client configuration.

Get MQTT client configuration.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/mqtt

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "protocolVersion": "3.1.1",
    • "server": "127.0.0.1",
    • "port": 1883,
    • "keepAliveSec": 60,
    • "handshakeTimeout": 10,
    • "retryInterval": 60,
    • "clearSession": true,
    • "certificateOverTLS": false,
    • "clientID": "mydevice1",
    • "userName": "moxa",
    • "password": "123",
    • "tlsVersion": "1.2",
    • "insecureSkipVerify": false,
    • "certificate": {

      • "rootCaCertFile": "",
      • "caCertFile": "",
      • "caPkFile": ""

      },
    • "qos": 1,
    • "retain": false,
    • "willMessage": {

      • "enable": true,
      • "topic": "/devices/1/will",
      • "message": "dead",
      • "qos": 1,
      • "retain": true

      },
    • "remoteAPI": {

      • "enable": true,
      • "requestSubTopic": "/devices/1/request",
      • "responsePubTopic": "/devices/1/response",
      • "ttl": 60,
      • "qos": 1,
      • "retain": false

      }

    }

  ]

}

Create a MQTT client configuration.

Create a MQTT client configuration.

Authorizations:

bearerAuth

Request Body schema:

application/jsonmultipart/form-dataapplication/json

enable	boolean Default: false
protocolVersion	string Default: "3.1.1" Enum: 3.1 "3.1.1" MQTT protocol version
server required	string MQTT server(broker) ip or url
port required	integer
keepAliveSec	integer [ 10 .. 65536 ] Default: 60
handshakeTimeout	integer [ 10 .. 600 ] Default: 10
retryInterval	integer [ 10 .. 3600 ] Default: 60
clearSession	boolean Default: true
certificateOverTLS	boolean Default: false
clientID	string Max length: 65536 in V3.1.1, 23 in V3.1
userName	string <= 255 characters
password	string <= 255 characters
tlsVersion	string Default: 1.2 Enum: "1.3" "1.2" "1.1" "1.0"
insecureSkipVerify	boolean Default: false
	object
qos	integer Default: 1 support qos 0,1,2
retain	boolean Default: false
	object
	object ThingsPro Edge REST API invocation(request/response patten) required headers: request-expired-time: UTC request-id: int string

Responses

http://127.0.0.1/api/v1/mqtt

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

{

• "id": 1,
• "enable": true,
• "status": "connected",
• "protocolVersion": "3.1.1",
• "server": "127.0.0.1",
• "port": 1883,
• "keepAliveSec": 60,
• "handshakeTimeout": 10,
• "retryInterval": 60,
• "clearSession": true,
• "certificateOverTLS": false,
• "clientID": "mydevice1",
• "userName": "moxa",
• "password": "123",
• "tlsVersion": "1.2",
• "insecureSkipVerify": false,
• "certificate": {

  • "rootCaCertFile": "",
  • "caCertFile": "",
  • "caPkFile": ""

  },
• "qos": 1,
• "retain": false,
• "willMessage": {

  • "enable": true,
  • "topic": "/devices/1/will",
  • "message": "dead",
  • "qos": 1,
  • "retain": true

  },
• "remoteAPI": {

  • "enable": true,
  • "requestSubTopic": "/devices/1/request",
  • "responsePubTopic": "/devices/1/response",
  • "ttl": 60,
  • "qos": 1,
  • "retain": false

  }

}

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "protocolVersion": "3.1.1",
    • "server": "127.0.0.1",
    • "port": 1883,
    • "keepAliveSec": 60,
    • "handshakeTimeout": 10,
    • "retryInterval": 60,
    • "clearSession": true,
    • "certificateOverTLS": false,
    • "clientID": "mydevice1",
    • "userName": "moxa",
    • "password": "123",
    • "tlsVersion": "1.2",
    • "insecureSkipVerify": false,
    • "certificate": {

      • "rootCaCertFile": "",
      • "caCertFile": "",
      • "caPkFile": ""

      },
    • "qos": 1,
    • "retain": false,
    • "willMessage": {

      • "enable": true,
      • "topic": "/devices/1/will",
      • "message": "dead",
      • "qos": 1,
      • "retain": true

      },
    • "remoteAPI": {

      • "enable": true,
      • "requestSubTopic": "/devices/1/request",
      • "responsePubTopic": "/devices/1/response",
      • "ttl": 60,
      • "qos": 1,
      • "retain": false

      }

    }

  ]

}

Edit MQTT client configuration.

Edit MQTT client configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Request Body schema:

application/jsonmultipart/form-dataapplication/json

enable	boolean Default: false
protocolVersion	string Default: "3.1.1" Enum: 3.1 "3.1.1" MQTT protocol version
server required	string MQTT server(broker) ip or url
port required	integer
keepAliveSec	integer [ 10 .. 65536 ] Default: 60
handshakeTimeout	integer [ 10 .. 600 ] Default: 10
retryInterval	integer [ 10 .. 3600 ] Default: 60
clearSession	boolean Default: true
certificateOverTLS	boolean Default: false
clientID	string Max length: 65536 in V3.1.1, 23 in V3.1
userName	string <= 255 characters
password	string <= 255 characters
tlsVersion	string Default: 1.2 Enum: "1.3" "1.2" "1.1" "1.0"
insecureSkipVerify	boolean Default: false
	object
qos	integer Default: 1 support qos 0,1,2
retain	boolean Default: false
	object
	object ThingsPro Edge REST API invocation(request/response patten) required headers: request-expired-time: UTC request-id: int string

Responses

http://127.0.0.1/api/v1/mqtt/{id}

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

{

• "id": 1,
• "enable": true,
• "status": "connected",
• "protocolVersion": "3.1.1",
• "server": "127.0.0.1",
• "port": 1883,
• "keepAliveSec": 60,
• "handshakeTimeout": 10,
• "retryInterval": 60,
• "clearSession": true,
• "certificateOverTLS": false,
• "clientID": "mydevice1",
• "userName": "moxa",
• "password": "123",
• "tlsVersion": "1.2",
• "insecureSkipVerify": false,
• "certificate": {

  • "rootCaCertFile": "",
  • "caCertFile": "",
  • "caPkFile": ""

  },
• "qos": 1,
• "retain": false,
• "willMessage": {

  • "enable": true,
  • "topic": "/devices/1/will",
  • "message": "dead",
  • "qos": 1,
  • "retain": true

  },
• "remoteAPI": {

  • "enable": true,
  • "requestSubTopic": "/devices/1/request",
  • "responsePubTopic": "/devices/1/response",
  • "ttl": 60,
  • "qos": 1,
  • "retain": false

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "status": "connected",
  • "protocolVersion": "3.1.1",
  • "server": "127.0.0.1",
  • "port": 1883,
  • "keepAliveSec": 60,
  • "handshakeTimeout": 10,
  • "retryInterval": 60,
  • "clearSession": true,
  • "certificateOverTLS": false,
  • "clientID": "mydevice1",
  • "userName": "moxa",
  • "password": "123",
  • "tlsVersion": "1.2",
  • "insecureSkipVerify": false,
  • "certificate": {

    • "rootCaCertFile": "",
    • "caCertFile": "",
    • "caPkFile": ""

    },
  • "qos": 1,
  • "retain": false,
  • "willMessage": {

    • "enable": true,
    • "topic": "/devices/1/will",
    • "message": "dead",
    • "qos": 1,
    • "retain": true

    },
  • "remoteAPI": {

    • "enable": true,
    • "requestSubTopic": "/devices/1/request",
    • "responsePubTopic": "/devices/1/response",
    • "ttl": 60,
    • "qos": 1,
    • "retain": false

    }

  }

}

delete MQTT client configuration.

delete MQTT client configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Responses

http://127.0.0.1/api/v1/mqtt/{id}

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "protocolVersion": "3.1.1",
    • "server": "127.0.0.1",
    • "port": 1883,
    • "keepAliveSec": 60,
    • "handshakeTimeout": 10,
    • "retryInterval": 60,
    • "clearSession": true,
    • "certificateOverTLS": false,
    • "clientID": "mydevice1",
    • "userName": "moxa",
    • "password": "123",
    • "tlsVersion": "1.2",
    • "insecureSkipVerify": false,
    • "certificate": {

      • "rootCaCertFile": "",
      • "caCertFile": "",
      • "caPkFile": ""

      },
    • "qos": 1,
    • "retain": false,
    • "willMessage": {

      • "enable": true,
      • "topic": "/devices/1/will",
      • "message": "dead",
      • "qos": 1,
      • "retain": true

      },
    • "remoteAPI": {

      • "enable": true,
      • "requestSubTopic": "/devices/1/request",
      • "responsePubTopic": "/devices/1/response",
      • "ttl": 60,
      • "qos": 1,
      • "retain": false

      }

    }

  ]

}

delete certficate.

delete certficate.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Responses

http://127.0.0.1/api/v1/mqtt/{id}/certificates

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "status": "connected",
  • "protocolVersion": "3.1.1",
  • "server": "127.0.0.1",
  • "port": 1883,
  • "keepAliveSec": 60,
  • "handshakeTimeout": 10,
  • "retryInterval": 60,
  • "clearSession": true,
  • "certificateOverTLS": false,
  • "clientID": "mydevice1",
  • "userName": "moxa",
  • "password": "123",
  • "tlsVersion": "1.2",
  • "insecureSkipVerify": false,
  • "certificate": {

    • "rootCaCertFile": "",
    • "caCertFile": "",
    • "caPkFile": ""

    },
  • "qos": 1,
  • "retain": false,
  • "willMessage": {

    • "enable": true,
    • "topic": "/devices/1/will",
    • "message": "dead",
    • "qos": 1,
    • "retain": true

    },
  • "remoteAPI": {

    • "enable": true,
    • "requestSubTopic": "/devices/1/request",
    • "responsePubTopic": "/devices/1/response",
    • "ttl": 60,
    • "qos": 1,
    • "retain": false

    }

  }

}

get store and forward setting.

get store and forward setting.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Responses

http://127.0.0.1/api/v1/mqtt/{id}/store-and-forward

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

update store and forward setting.

update store and forward setting.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Request Body schema: application/json

enable	boolean Default: false
targetDiskName	string
desiredDiskCacheSizeMB	integer
timeToLiveSec	integer
dropBehavior	string Enum: "oldest" "newest"
	Array of objects[ items ]

Responses

http://127.0.0.1/api/v1/mqtt/{id}/store-and-forward

Request samples

• Payload

Content type

application/json

{

• "enable": true,
• "targetDiskName": "System",
• "desiredDiskCacheSizeMB": 8,
• "timeToLiveSec": 7200,
• "dropBehavior": "oldest"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

get message groups setting.

get message groups setting.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

create a message group.

create a message group.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

get message group setting.

get message group setting.

Authorizations:

bearerAuth

path Parameters

id required	integer the id in the configuration of mqtt clients.
group_id required	integer the id in the configuration of message groups.

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages/{group_id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

update message group setting.

update message group setting.

Authorizations:

bearerAuth

path Parameters

id required	integer the id in the configuration of mqtt clients.
group_id required	integer the id in the configuration of message groups.

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages/{group_id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

delete message group setting.

delete message group setting.

Authorizations:

bearerAuth

path Parameters

id required	integer the id in the configuration of mqtt clients.
group_id required	integer the id in the configuration of message groups.

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages/{group_id}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

test custom payload.

test custom payload.

Authorizations:

bearerAuth

path Parameters

id required

integer the id in the configuration of mqtt clients.

Request Body schema: application/json

format	string
	Array of objects (Tag) [ items ]

Responses

http://127.0.0.1/api/v1/mqtt/{id}/messages/test

Request samples

• Payload

Content type

application/json

{

• "format": "{time: (now|todateiso8601), (.srcName): { (.tagName): .dataValue} }",
• "tags": [

  • {

    • "srcName": "system",
    • "tagName": "cpuUsage",
    • "dataType": "int32",
    • "duration": 1000,
    • "access": "ro"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "system": {

    • "cpuUsage": 60

    },
  • "time": "2019-09-27T11:42:34Z"

  }

}

azure_device

Get azure iot device configuration.

Get azure iot device configuration.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-device

Response samples

• 200

Content type

application/json

{

• "data": {

  • "status": "connected",
  • "provisioning": {

    • "authenticationType": "symmetricKey",
    • "connectionString": "[connection string]",
    • "enable": true,
    • "protocol": {

      • "capabilities": [

        • {

          • "protocol": "mqtt",
          • "port": 8883

          },
        • {

          • "protocol": "mqttOverWebsocket",
          • "port": 443

          },
        • {

          • "protocol": "amqp",
          • "port": 5671

          },
        • {

          • "protocol": "amqpOverWebsocket",
          • "port": 443

          }

        ],
      • "protocol": "mqtt",
      • "port": 8883

      },
    • "supportTwin": true,
    • "certificate": {

      • "caPkFile": "device.key",
      • "caCertFile": "device.crt"

      },
    • "rootCaCertFile": "root.crt"

    }

  }

}

Update provisioning configuration.

Update provisioning configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
enable boolean Default: false object keepAlive integer [ 1 .. 3600 ] Default: 60 unit: second supportTwin boolean Default: true authenticationType string Default: "symmetricKey" Enum: "x509" "symmetricKey" The identity provisioning mode of the iot device. connectionString string [ 1 .. 1024 ] characters object X509 certificate rootCaCertFile string root ca certificate file name

Responses

http://127.0.0.1/api/v1/azure-device

Request samples

• Payload

Content type

application/json

Example

symmetricKey modeswitch to X509 mode (need import certificate)enable/disable device managementchange communication protocolsymmetricKey mode

{

• "provisioning": {

  • "enable": true,
  • "authenticationType": "symmetricKey",
  • "supportTwin": true,
  • "connectionString": "connection-string-test",
  • "keepAlive": 60,
  • "protocol": {

    • "protocol": "mqtt"

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "provisioning": {

    • "authenticationType": "symmetricKey",
    • "connectionString": "connection-string-test",
    • "enable": true,
    • "supportTwin": true,
    • "certificate": {

      • "caPkFile": "",
      • "caCertFile": "",
      • "certificateInfo": {

        • "notAfter": "",
        • "subject": {

          • "cn": ""

          },
        • "issuer": ""

        }

      }

    },
  • "status": "connected"

  }

}

Setup x509 certificates.

Setup x509 certificates.

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

caCertFile	string <binary> device ca certificate
caPkFile	string <binary> device ca private key
rootCaCertFile	string <binary> root ca certificate
connectionString	string [ 1 .. 1024 ] characters
protocol	string Enum: "mqtt" "mqttOverWebsocket" "amqp" "amqpOverWebsocket" Communication protocol

Responses

http://127.0.0.1/api/v1/azure-device

Response samples

• 200

Content type

application/json

{

• "data": {

  • "status": "connected",
  • "provisioning": {

    • "authenticationType": "symmetricKey",
    • "connectionString": "[connection string]",
    • "enable": true,
    • "protocol": {

      • "capabilities": [

        • {

          • "protocol": "mqtt",
          • "port": 8883

          },
        • {

          • "protocol": "mqttOverWebsocket",
          • "port": 443

          },
        • {

          • "protocol": "amqp",
          • "port": 5671

          },
        • {

          • "protocol": "amqpOverWebsocket",
          • "port": 443

          }

        ],
      • "protocol": "mqtt",
      • "port": 8883

      },
    • "supportTwin": true,
    • "certificate": {

      • "caPkFile": "device.key",
      • "caCertFile": "device.crt"

      },
    • "rootCaCertFile": "root.crt"

    }

  }

}

get twin properties setting.

get twin properties setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-device/twin/properties

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

update twin properties setting.

update twin properties setting.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
Array of objects[ items ] Array source string json path of property in resource; empty == "."(complete json object/array) reportedPath required string json path of reported property. desiredPath required string json path of desired property.

Responses

http://127.0.0.1/api/v1/azure-device/twin/properties

Request samples

• Payload

Content type

application/json

{

• "device": {

  • "general": [

    • {

      • "reportedPath": "general",
      • "desiredPath": "general"

      }

    ],
  • "wan": [

    • {

      • "reportedPath": "wan",
      • "desiredPath": "wan"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

reported twin properties.

reported twin properties.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-device/twin/reported

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

clear twin properties.

clear twin properties.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

string

Responses

http://127.0.0.1/api/v1/azure-device/twin/clear

Request samples

• Payload

Content type

application/json

[

• "general",
• "ethernets"

]

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

get store and forward setting.

get store and forward setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-device/store-and-forward

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

update store and forward setting.

update store and forward setting.

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean Default: false
targetDiskName	string
desiredDiskCacheSizeMB	integer
timeToLiveSec	integer
dropBehavior	string Enum: "oldest" "newest"
	Array of objects[ items ]

Responses

http://127.0.0.1/api/v1/azure-device/store-and-forward

Request samples

• Payload

Content type

application/json

{

• "enable": true,
• "targetDiskName": "System",
• "desiredDiskCacheSizeMB": 8,
• "timeToLiveSec": 7200,
• "dropBehavior": "oldest"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

get message groups setting.

get message groups setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-device/messages

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

create a message group.

create a message group.

Authorizations:

bearerAuth

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/azure-device/messages

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

get message group setting.

get message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/azure-device/messages/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

update message group setting.

update message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/azure-device/messages/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

delete message group setting.

delete message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/azure-device/messages/{id}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

test custom payload.

test custom payload.

Authorizations:

bearerAuth

Request Body schema: application/json

format	string
	Array of objects (Tag) [ items ]

Responses

http://127.0.0.1/api/v1/azure-device/messages/test

Request samples

• Payload

Content type

application/json

{

• "format": "{ time : (now|todateiso8601), (.srcName) : { (.tagName) : .dataValue}}",
• "tags": [

  • {

    • "srcName": "system",
    • "tagName": "cpuUsage",
    • "dataType": "int32",
    • "duration": 1000,
    • "dataUnit": "%",
    • "access": "ro"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "system": {

    • "cpuUsage": 60

    },
  • "time": "2019-09-27T11:42:34Z"

  }

}

aws

Get AWS iot device configuration.

Get AWS iot device configuration.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/aws

Response samples

• 200

Content type

application/json

{

• "data": {

  • "status": "connected",
  • "provisioning": {

    • "enable": true,
    • "host": "a22j5sm6o3yzc5.iot.us-east-1.amazonaws.com",
    • "port": 8883,
    • "thingID": "MyThingsproEdge",
    • "supportDM": true,
    • "messageQOS": 0,
    • "certificate": {

      • "rootCaCertFile": "rootCA.crt",
      • "caPkFile": "private.key",
      • "caCertFile": "device.crt"

      }

    }

  }

}

Update provisioning configuration.

Update provisioning configuration.

Authorizations:

bearerAuth

Request Body schema:

application/jsonmultipart/form-dataapplication/json

	object
enable boolean Default: false host string port integer Default: 8883 thingID string messageQOS integer Default: 0 keepAliveSec integer [ 1 .. 3600 ] Default: 60 unit: second supportDM boolean Default: true object

Responses

http://127.0.0.1/api/v1/aws

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

{

• "status": "connected",
• "provisioning": {

  • "enable": true,
  • "host": "a22j5sm6o3yzc5.iot.us-east-1.amazonaws.com",
  • "port": 8883,
  • "thingID": "MyThingsproEdge",
  • "supportDM": true,
  • "messageQOS": 0,
  • "certificate": {

    • "rootCaCertFile": "rootCA.crt",
    • "caPkFile": "private.key",
    • "caCertFile": "device.crt"

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "status": "connected",
  • "provisioning": {

    • "enable": true,
    • "host": "a22j5sm6o3yzc5.iot.us-east-1.amazonaws.com",
    • "port": 8883,
    • "thingID": "MyThingsproEdge",
    • "supportDM": true,
    • "messageQOS": 0,
    • "certificate": {

      • "rootCaCertFile": "rootCA.crt",
      • "caPkFile": "private.key",
      • "caCertFile": "device.crt"

      }

    }

  }

}

get shadow properties setting.

get shadow properties setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/aws/shadow/properties

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

update shadow properties setting.

update shadow properties setting.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
Array of objects[ items ] Array source string json path of property in resource; empty == "."(complete json object/array) reportedPath required string json path of reported property. desiredPath required string json path of desired property.

Responses

http://127.0.0.1/api/v1/aws/shadow/properties

Request samples

• Payload

Content type

application/json

{

• "device": {

  • "general": [

    • {

      • "reportedPath": "general",
      • "desiredPath": "general"

      }

    ],
  • "wan": [

    • {

      • "reportedPath": "wan",
      • "desiredPath": "wan"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

reported shadow properties.

reported shadow properties.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/aws/shadow/reported

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

clear shadow properties.

clear shadow properties.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

string

Responses

http://127.0.0.1/api/v1/aws/shadow/clear

Request samples

• Payload

Content type

application/json

[

• "general",
• "ethernets"

]

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

get store and forward setting.

get store and forward setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/aws/store-and-forward

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

update store and forward setting.

update store and forward setting.

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean Default: false
targetDiskName	string
desiredDiskCacheSizeMB	integer
timeToLiveSec	integer
dropBehavior	string Enum: "oldest" "newest"
	Array of objects[ items ]

Responses

http://127.0.0.1/api/v1/aws/store-and-forward

Request samples

• Payload

Content type

application/json

{

• "enable": true,
• "targetDiskName": "System",
• "desiredDiskCacheSizeMB": 8,
• "timeToLiveSec": 7200,
• "dropBehavior": "oldest"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

get message groups setting.

get message groups setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/aws/messages

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

create a message group.

create a message group.

Authorizations:

bearerAuth

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/aws/messages

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

get message group setting.

get message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/aws/messages/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

update message group setting.

update message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/aws/messages/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

delete message group setting.

delete message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/aws/messages/{id}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

test custom payload.

test custom payload.

Authorizations:

bearerAuth

Request Body schema: application/json

format	string
	Array of objects (Tag) [ items ]

Responses

http://127.0.0.1/api/v1/aws/messages/test

Request samples

• Payload

Content type

application/json

{

• "format": "{ time : (now|todateiso8601), (.srcName) : { (.tagName) : .dataValue}}",
• "tags": [

  • {

    • "srcName": "system",
    • "tagName": "cpuUsage",
    • "dataType": "int32",
    • "duration": 1000,
    • "dataUnit": "%",
    • "access": "ro"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "system": {

    • "cpuUsage": 60

    },
  • "time": "2019-09-27T11:42:34Z"

  }

}

azure_iotedge

Get azure iotedge configuration.

Get azure iotedge configuration.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge

Response samples

• 200

Content type

application/json

{

• "data": {

  • "iotedge": {

    • "version": "string",
    • "status": "resetting",
    • "since": "Mon 2016-10-07 09:49:16 CST",
    • "match": true,
    • "suggestion": "string",
    • "modules": [

      • {

        • "status": "string",
        • "config": "string",
        • "description": "string",
        • "name": "string",
        • "match": true,
        • "suggestion": "string"

        }

      ]

    },
  • "provisioning": {

    • "enable": false,
    • "supportTwin": true,
    • "globalEndpoint": "https://global.azure-devices-provisioning.net",
    • "source": "manual",
    • "method": "tpm",
    • "connectionString": "string",
    • "scopeId": "string",
    • "symmetricKey": "string",
    • "identityCert": "string",
    • "identityPk": "string",
    • "registrationId": "string",
    • "endorsementKey": "string"

    },
  • "downstreamCerts": {

    • "mode": "default",
    • "caCertFile": "string",
    • "caPkFile": "string",
    • "trustedCaFile": "string",
    • "certificateInfo": {

      • "issuer": "string",
      • "notAfter": "string",
      • "subject": {

        • "cn": "string"

        }

      }

    }

  }

}

Update azure iotedge configuration.

Update azure iotedge configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

	object IoT Edge runtime information
	object
	object

Responses

http://127.0.0.1/api/v1/azure-iotedge

Request samples

• Payload

Content type

application/json

Example

enable-serviceprovisioning-manualprovisioning-dps-tpmprovisioning-dps-symmetricKeyprovisioning-dps-x509downstreamCerts-defaultdownstreamCerts-moxaenable-service

{

• "provisioning": {

  • "enable": true

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "iotedge": {

    • "version": "string",
    • "status": "resetting",
    • "since": "Mon 2016-10-07 09:49:16 CST",
    • "match": true,
    • "suggestion": "string",
    • "modules": [

      • {

        • "status": "string",
        • "config": "string",
        • "description": "string",
        • "name": "string",
        • "match": true,
        • "suggestion": "string"

        }

      ]

    },
  • "provisioning": {

    • "enable": false,
    • "supportTwin": true,
    • "globalEndpoint": "https://global.azure-devices-provisioning.net",
    • "source": "manual",
    • "method": "tpm",
    • "connectionString": "string",
    • "scopeId": "string",
    • "symmetricKey": "string",
    • "identityCert": "string",
    • "identityPk": "string",
    • "registrationId": "string",
    • "endorsementKey": "string"

    },
  • "downstreamCerts": {

    • "mode": "default",
    • "caCertFile": "string",
    • "caPkFile": "string",
    • "trustedCaFile": "string",
    • "certificateInfo": {

      • "issuer": "string",
      • "notAfter": "string",
      • "subject": {

        • "cn": "string"

        }

      }

    }

  }

}

Reset AIE APP(include iotedge runtime pkgs).

Reset AIE APP(include iotedge runtime pkgs).

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge/reset

Response samples

• 202
• 400

Content type

application/json

{

• "data": {

  • "iotedge": {

    • "status": "resetting"

    }

  }

}

Control azure iotedge service.

Control azure iotedge service.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge/restart

Response samples

• 200
• 400

Content type

application/json

{

• "data": {

  • "iotedge": {

    • "version": "string",
    • "status": "resetting",
    • "since": "Mon 2016-10-07 09:49:16 CST",
    • "match": true,
    • "suggestion": "string",
    • "modules": [

      • {

        • "status": "string",
        • "config": "string",
        • "description": "string",
        • "name": "string",
        • "match": true,
        • "suggestion": "string"

        }

      ]

    },
  • "provisioning": {

    • "enable": false,
    • "supportTwin": true,
    • "globalEndpoint": "https://global.azure-devices-provisioning.net",
    • "source": "manual",
    • "method": "tpm",
    • "connectionString": "string",
    • "scopeId": "string",
    • "symmetricKey": "string",
    • "identityCert": "string",
    • "identityPk": "string",
    • "registrationId": "string",
    • "endorsementKey": "string"

    },
  • "downstreamCerts": {

    • "mode": "default",
    • "caCertFile": "string",
    • "caPkFile": "string",
    • "trustedCaFile": "string",
    • "certificateInfo": {

      • "issuer": "string",
      • "notAfter": "string",
      • "subject": {

        • "cn": "string"

        }

      }

    }

  }

}

Restart azure module.

Restart azure module.

Authorizations:

bearerAuth

path Parameters

name required

string Value: "restart" control action.

Responses

http://127.0.0.1/api/v1/azure-iotedge/modules/{name}/restart

Response samples

• 200
• 400

Content type

application/json

{

• "data": "edgeAgent enable task is accepted"

}

Import user certificates and update azure iotedge

Import user certificates and update azure iotedge configuration.

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

The uploaded certificates and configuration.

caCertFile	string <binary> device ca certificate
caPkFile	string <binary> device ca private key
trustedCaFile	string <binary> a file containing all the trusted CA

Responses

http://127.0.0.1/api/v1/azure-iotedge/certificates

Response samples

• 200

Content type

application/json

{

• "data": {

  • "iotedge": {

    • "version": "string",
    • "status": "resetting",
    • "since": "Mon 2016-10-07 09:49:16 CST",
    • "match": true,
    • "suggestion": "string",
    • "modules": [

      • {

        • "status": "string",
        • "config": "string",
        • "description": "string",
        • "name": "string",
        • "match": true,
        • "suggestion": "string"

        }

      ]

    },
  • "provisioning": {

    • "enable": false,
    • "supportTwin": true,
    • "globalEndpoint": "https://global.azure-devices-provisioning.net",
    • "source": "manual",
    • "method": "tpm",
    • "connectionString": "string",
    • "scopeId": "string",
    • "symmetricKey": "string",
    • "identityCert": "string",
    • "identityPk": "string",
    • "registrationId": "string",
    • "endorsementKey": "string"

    },
  • "downstreamCerts": {

    • "mode": "default",
    • "caCertFile": "string",
    • "caPkFile": "string",
    • "trustedCaFile": "string",
    • "certificateInfo": {

      • "issuer": "string",
      • "notAfter": "string",
      • "subject": {

        • "cn": "string"

        }

      }

    }

  }

}

get twin properties setting.

get twin properties setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge/twin/properties

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

update twin properties setting.

update twin properties setting.

Authorizations:

bearerAuth

Request Body schema: application/json

	object
Array of objects[ items ] Array source string json path of property in resource; empty == "."(complete json object/array) reportedPath required string json path of reported property. desiredPath required string json path of desired property.

Responses

http://127.0.0.1/api/v1/azure-iotedge/twin/properties

Request samples

• Payload

Content type

application/json

{

• "device": {

  • "general": [

    • {

      • "reportedPath": "general",
      • "desiredPath": "general"

      }

    ],
  • "wan": [

    • {

      • "reportedPath": "wan",
      • "desiredPath": "wan"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "device": {

    • "general": [

      • {

        • "reportedPath": "general",
        • "desiredPath": "general"

        }

      ],
    • "wan": [

      • {

        • "reportedPath": "wan",
        • "desiredPath": "wan"

        }

      ]

    }

  }

}

reported twin properties.

reported twin properties.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge/twin/reported

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

clear twin properties.

clear twin properties.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

string

Responses

http://127.0.0.1/api/v1/azure-iotedge/twin/clear

Request samples

• Payload

Content type

application/json

[

• "general",
• "ethernets"

]

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

get message groups setting.

get message groups setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

create a message group.

create a message group.

Authorizations:

bearerAuth

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

get message group setting.

get message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

update message group setting.

update message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Request Body schema: application/json

enable required	boolean
	Array of objects[ items ]
required	object
outputTopic required	string non-empty Default: "sample"
pollingInterval required	integer [ 0 .. 86400 ] characters Default: 0 unit:second
	object
format	string [ 0 .. 4096 ] characters Default: "" jq filter string, use to change message format. empty means use default message format: {tags:{(.prvdName):{(.srcName):{(.tagName):{values:[{updateTimeStamp:(.ts/1000|todateiso8601),value:.dataValue}]}}}}}

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "outputTopic": "sample2",
• "properties": [ ],
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    },
  • "system": {

    • "system": [

      • "cpuUsage",
      • "memoryUsage"

      ]

    }

  },
• "pollingInterval": 5,
• "sendOutThreshold": {

  • "size": 4096,
  • "time": 120

  },
• "format": ""

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

}

delete message group setting.

delete message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages/{id}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "outputTopic": "sample2",
  • "properties": [ ],
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      },
    • "system": {

      • "system": [

        • "cpuUsage",
        • "memoryUsage"

        ]

      }

    },
  • "pollingInterval": 5,
  • "sendOutThreshold": {

    • "size": 4096,
    • "time": 120

    },
  • "format": ""

  }

]

test custom payload.

test custom payload.

Authorizations:

bearerAuth

Request Body schema: application/json

format	string
	Array of objects (Tag) [ items ]

Responses

http://127.0.0.1/api/v1/azure-iotedge/messages/test

Request samples

• Payload

Content type

application/json

{

• "format": "{ time : (now|todateiso8601), (.srcName) : { (.tagName) : .dataValue}}",
• "tags": [

  • {

    • "srcName": "system",
    • "tagName": "cpuUsage",
    • "dataType": "int32",
    • "duration": 1000,
    • "dataUnit": "%",
    • "access": "ro"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "system": {

    • "cpuUsage": 60

    },
  • "time": "2019-09-27T11:42:34Z"

  }

}

sparkplug

Get Sparkplug configuration.

Get Sparkplug configuration.

Authorizations:

bearerAuth

query Parameters

event

boolean Get runtime status, ex: {"brokerList":[{"id":1,"status":"connected"}]}

Responses

http://127.0.0.1/api/v1/sparkplug

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "enableDM": false,
  • "nodeID": "gary",
  • "groupID": "thingspro-edges",
  • "uuid": "",
  • "primaryHostID": "garyig",
  • "handshakeTimeout": 10,
  • "retryInterval": 10,
  • "maxRetries": 3,
  • "brokerList": [

    • {

      • "id": 1,
      • "enable": true,
      • "status": "connected",
      • "lastConnectedTime": "May 20, 2020, 14:05",
      • "server": "test.sparkplug.org",
      • "port": 1883,
      • "keepAliveSec": 10,
      • "userName": "admin",
      • "password": "password"

      }

    ]

  }

}

Update Sparkplug configuration.(BrokerList is read

Update Sparkplug configuration.(BrokerList is readOnly in this endpoint)

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean Default: false
enableDM	boolean Default: false
nodeID required	string [ 1 .. 255 ] characters The format can be valid UTF-8 alphanumeric String with the exception of the reserved characters of "+", "/", "#"
groupID required	string [ 1 .. 255 ] characters The format can be valid UTF-8 alphanumeric String with the exception of the reserved characters of "+", "/", "#"
uuid	string [ 0 .. 255 ] characters The format can be valid UTF-8 alphanumeric String. UUID to track message type in terms of schema definitions
primaryHostID	string [ 0 .. 255 ] characters The format can be valid UTF-8 alphanumeric String.
handshakeTimeout	integer [ 1 .. 600 ] Default: 10
maxRetries	integer [ 0 .. 60 ] Default: 3
retryInterval	integer [ 10 .. 3600 ] Default: 60
	Array of objects (Sparkplug broker configuration) [ items ]

Responses

http://127.0.0.1/api/v1/sparkplug

Request samples

• Payload

Content type

application/json

{

• "enable": true,
• "enableDM": false,
• "nodeID": "gary",
• "groupID": "thingspro-edges",
• "uuid": "",
• "primaryHostID": "garyig",
• "handshakeTimeout": 10,
• "retryInterval": 10,
• "maxRetries": 3,
• "brokerList": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "lastConnectedTime": "May 20, 2020, 14:05",
    • "server": "test.sparkplug.org",
    • "port": 1883,
    • "keepAliveSec": 10,
    • "userName": "admin",
    • "password": "password"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "enableDM": false,
  • "nodeID": "gary",
  • "groupID": "thingspro-edges",
  • "uuid": "",
  • "primaryHostID": "garyig",
  • "handshakeTimeout": 10,
  • "retryInterval": 10,
  • "maxRetries": 3,
  • "brokerList": [

    • {

      • "id": 1,
      • "enable": true,
      • "status": "connected",
      • "lastConnectedTime": "May 20, 2020, 14:05",
      • "server": "test.sparkplug.org",
      • "port": 1883,
      • "keepAliveSec": 10,
      • "userName": "admin",
      • "password": "password"

      }

    ]

  }

}

Download configurations

Authorizations:

bearerAuth

query Parameters

encryption

boolean Default: true Use password to encryption (default:true)

header Parameters

password

string password

Responses

http://127.0.0.1/api/v1/sparkplug/configuration

Upload configurations

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

decryption	boolean Default: true Use password to decryption (default:true)
file	string <binary> configuration file
password	string password

Responses

http://127.0.0.1/api/v1/sparkplug/configuration

Response samples

• 200
• 400

Content type

application/json

{

• "data": {

  • "fileName": "2019-12-19-13-52-backup.zip",
  • "fileSize": 46272

  }

}

Get Sparkplug brokers configuration.

Get Sparkplug brokers configuration.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/sparkplug/brokers

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "lastConnectedTime": "May 20, 2020, 14:05",
    • "server": "test.sparkplug.org",
    • "port": 1883,
    • "keepAliveSec": 10,
    • "userName": "admin",
    • "password": "password"

    }

  ]

}

Update Sparkplug brokers configuration.

Update Sparkplug brokers configuration.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

enable	boolean Default: false
server required	string MQTT server(broker) ip or url
port required	integer [ 1 .. 65536 ]
keepAliveSec	integer [ 10 .. 65536 ] Default: 60
certificateOverTLS	boolean Default: false
clientID	string Max length: 65536 in V3.1.1, 23 in V3.1
userName	string <= 255 characters
password	string <= 255 characters
tlsVersion	string Default: 1.2 Enum: "1.3" "1.2" "1.1" "1.0"
insecureSkipVerify	boolean Default: false
	object

Responses

http://127.0.0.1/api/v1/sparkplug/brokers

Request samples

• Payload

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "status": "connected",
  • "lastConnectedTime": "May 20, 2020, 14:05",
  • "server": "test.sparkplug.org",
  • "port": 1883,
  • "keepAliveSec": 10,
  • "userName": "admin",
  • "password": "password"

  }

]

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "lastConnectedTime": "May 20, 2020, 14:05",
    • "server": "test.sparkplug.org",
    • "port": 1883,
    • "keepAliveSec": 10,
    • "userName": "admin",
    • "password": "password"

    }

  ]

}

Create a new Sparkplug broker configuration.

Create a new Sparkplug broker configuration.

Authorizations:

bearerAuth

Request Body schema:

application/jsonmultipart/form-dataapplication/json

enable	boolean Default: false
server required	string MQTT server(broker) ip or url
port required	integer [ 1 .. 65536 ]
keepAliveSec	integer [ 10 .. 65536 ] Default: 60
certificateOverTLS	boolean Default: false
clientID	string Max length: 65536 in V3.1.1, 23 in V3.1
userName	string <= 255 characters
password	string <= 255 characters
tlsVersion	string Default: 1.2 Enum: "1.3" "1.2" "1.1" "1.0"
insecureSkipVerify	boolean Default: false
	object

Responses

http://127.0.0.1/api/v1/sparkplug/brokers

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

{

• "id": 1,
• "enable": true,
• "status": "connected",
• "lastConnectedTime": "May 20, 2020, 14:05",
• "server": "test.sparkplug.org",
• "port": 1883,
• "keepAliveSec": 10,
• "userName": "admin",
• "password": "password"

}

Response samples

• 200

Content type

application/json

{

• "data": [

  • {

    • "id": 1,
    • "enable": true,
    • "status": "connected",
    • "lastConnectedTime": "May 20, 2020, 14:05",
    • "server": "test.sparkplug.org",
    • "port": 1883,
    • "keepAliveSec": 10,
    • "userName": "admin",
    • "password": "password"

    }

  ]

}

Update Sparkplug broker configuration.

Update Sparkplug broker configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer broker id.

Request Body schema:

application/jsonmultipart/form-dataapplication/json

enable	boolean Default: false
server required	string MQTT server(broker) ip or url
port required	integer [ 1 .. 65536 ]
keepAliveSec	integer [ 10 .. 65536 ] Default: 60
certificateOverTLS	boolean Default: false
clientID	string Max length: 65536 in V3.1.1, 23 in V3.1
userName	string <= 255 characters
password	string <= 255 characters
tlsVersion	string Default: 1.2 Enum: "1.3" "1.2" "1.1" "1.0"
insecureSkipVerify	boolean Default: false
	object

Responses

http://127.0.0.1/api/v1/sparkplug/brokers/{id}

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

{

• "id": 1,
• "enable": true,
• "status": "connected",
• "lastConnectedTime": "May 20, 2020, 14:05",
• "server": "test.sparkplug.org",
• "port": 1883,
• "keepAliveSec": 10,
• "userName": "admin",
• "password": "password"

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "status": "connected",
  • "lastConnectedTime": "May 20, 2020, 14:05",
  • "server": "test.sparkplug.org",
  • "port": 1883,
  • "keepAliveSec": 10,
  • "userName": "admin",
  • "password": "password"

  }

}

Delete Sparkplug broker configuration.

Delete Sparkplug broker configuration.

Authorizations:

bearerAuth

path Parameters

id required

integer broker id.

Responses

http://127.0.0.1/api/v1/sparkplug/brokers/{id}

Response samples

• 200

Content type

application/json

{

• "data": [ ]

}

reported node properties.

reported node properties.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/sparkplug/node/reported

Response samples

• 200

Content type

application/json

{

• "data": "ok"

}

get store and forward setting.

get store and forward setting.

Authorizations:

bearerAuth

Responses

http://127.0.0.1/api/v1/sparkplug/store-and-forward

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "bulkUpload": {

    • "enable": false,
    • "size": 128

    },
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

update store and forward setting.

update store and forward setting.

Authorizations:

bearerAuth

Request Body schema: application/json

enable	boolean Default: false
targetDiskName	string
desiredDiskCacheSizeMB	integer
timeToLiveSec	integer
dropBehavior	string Enum: "oldest" "newest"
	Array of objects[ items ]
	object (Bluk Upload Configuration) Bulk data upload to server after device status change to connected.

Responses

http://127.0.0.1/api/v1/sparkplug/store-and-forward

Request samples

• Payload

Content type

application/json

{

• "enable": true,
• "targetDiskName": "System",
• "desiredDiskCacheSizeMB": 8,
• "timeToLiveSec": 7200,
• "dropBehavior": "oldest",
• "bulkUpload": {

  • "enable": false,
  • "size": 128

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "enable": true,
  • "targetDiskName": "System",
  • "desiredDiskCacheSizeMB": 8,
  • "timeToLiveSec": 7200,
  • "dropBehavior": "oldest",
  • "bulkUpload": {

    • "enable": false,
    • "size": 128

    },
  • "disks": [

    • {

      • "name": "System",
      • "mount": "/",
      • "device": "/dev/root",
      • "total": 3206059008,
      • "used": 6059008,
      • "free": 3200000000

      }

    ]

  }

}

get message groups setting.

get message groups setting.

Authorizations:

bearerAuth

query Parameters

type	string Enum: "node" "device"

Responses

http://127.0.0.1/api/v1/sparkplug/messages

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "description": "my message group",
  • "properties": [ ],
  • "onChange": false,
  • "minPublishInterval": 0,
  • "samplingMode": "allValues",
  • "customSamplingRate": false,
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      }

    },
  • "pollingInterval": 0,
  • "sendOutThreshold": {

    • "mode": "byTime",
    • "time": 60

    }

  }

]

create a message group.

create a message group.

Authorizations:

bearerAuth

query Parameters

type	string Enum: "node" "device"

Request Body schema: application/json

enable required	boolean
description	string <= 1024 characters
required	object
minPublishInterval	integer [ 0 .. 10 ] Default: 0 a fixed interval between the two publish. unit:second
samplingMode	string Default: "allChangedValues" Enum: "allValues" "latestValues" "allChangedValues" "latestChangedValues"
customSamplingRate	boolean Default: false enable will use the pollingInterval that user input.
pollingInterval	integer [ 0 .. 86400 ] characters Default: 10 unit:second, 0 means subscribe mode
required	object

Responses

http://127.0.0.1/api/v1/sparkplug/messages

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "description": "my message group",
• "properties": [ ],
• "onChange": false,
• "minPublishInterval": 0,
• "samplingMode": "allValues",
• "customSamplingRate": false,
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    }

  },
• "pollingInterval": 0,
• "sendOutThreshold": {

  • "mode": "byTime",
  • "time": 60

  }

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "description": "my message group",
  • "properties": [ ],
  • "onChange": false,
  • "minPublishInterval": 0,
  • "samplingMode": "allValues",
  • "customSamplingRate": false,
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      }

    },
  • "pollingInterval": 0,
  • "sendOutThreshold": {

    • "mode": "byTime",
    • "time": 60

    }

  }

]

get message group setting.

get message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/sparkplug/messages/{id}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "description": "my message group",
  • "properties": [ ],
  • "onChange": false,
  • "minPublishInterval": 0,
  • "samplingMode": "allValues",
  • "customSamplingRate": false,
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      }

    },
  • "pollingInterval": 0,
  • "sendOutThreshold": {

    • "mode": "byTime",
    • "time": 60

    }

  }

}

update message group setting.

update message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Request Body schema: application/json

enable required	boolean
description	string <= 1024 characters
required	object
minPublishInterval	integer [ 0 .. 10 ] Default: 0 a fixed interval between the two publish. unit:second
samplingMode	string Default: "allChangedValues" Enum: "allValues" "latestValues" "allChangedValues" "latestChangedValues"
customSamplingRate	boolean Default: false enable will use the pollingInterval that user input.
pollingInterval	integer [ 0 .. 86400 ] characters Default: 10 unit:second, 0 means subscribe mode
required	object

Responses

http://127.0.0.1/api/v1/sparkplug/messages/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "enable": true,
• "description": "my message group",
• "properties": [ ],
• "onChange": false,
• "minPublishInterval": 0,
• "samplingMode": "allValues",
• "customSamplingRate": false,
• "tags": {

  • "modbus": {

    • "myDevice1": [

      • "di0",
      • "di1"

      ]

    }

  },
• "pollingInterval": 0,
• "sendOutThreshold": {

  • "mode": "byTime",
  • "time": 60

  }

}

Response samples

• 200

Content type

application/json

{

• "data": {

  • "id": 1,
  • "enable": true,
  • "description": "my message group",
  • "properties": [ ],
  • "onChange": false,
  • "minPublishInterval": 0,
  • "samplingMode": "allValues",
  • "customSamplingRate": false,
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      }

    },
  • "pollingInterval": 0,
  • "sendOutThreshold": {

    • "mode": "byTime",
    • "time": 60

    }

  }

}

delete message group setting.

delete message group setting.

Authorizations:

bearerAuth

path Parameters

id required

integer message group id.

Responses

http://127.0.0.1/api/v1/sparkplug/messages/{id}

Response samples

• 200

Content type

application/json

[

• {

  • "id": 1,
  • "enable": true,
  • "description": "my message group",
  • "properties": [ ],
  • "onChange": false,
  • "minPublishInterval": 0,
  • "samplingMode": "allValues",
  • "customSamplingRate": false,
  • "tags": {

    • "modbus": {

      • "myDevice1": [

        • "di0",
        • "di1"

        ]

      }

    },
  • "pollingInterval": 0,
  • "sendOutThreshold": {

    • "mode": "byTime",
    • "time": 60

    }

  }

]