Commanding Feature – API Overview¶
Region Europe 1¶
Commanding 3.2.2
OAS 2.0
[ Base URL: /api/commanding/v3 ]/insights-hub/api_specs/commanding-v3-2-2-eu1.yaml
Commanding is a service that provides the APIs to manage delivery jobs to send commands to MQTT clients for execution.
Limitations
- The maximum number of clients to which a command can be published is 20.
- Command data size is restricted to 10kB.
Generic Errors
The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with 'mdsp.core.generic.'.
- missingParameter (400)
- invalidParameter (400)
- missingRequestBody (400)
- invalidRequestBody (400)
- unauthorized (401)
- forbidden (403)
- conflict (409)
- preconditionFailed (412)
- unsupportedMediaType (415)
- preconditionRequired (428)
- tooManyRequests (429)
- internalServerError (500)
MQTT Delivery JobManage jobs to publish MQTT commands to clients.
Manage jobs to publish MQTT commands to clients.
Region Private Cloud¶
Commanding 3.2.2
OAS 2.0
[ Base URL: /api/commanding/v3 ]/insights-hub/api_specs/commanding-v3-2-2-rancher.yaml
Commanding is a service that provides the APIs to manage delivery jobs to send commands to MQTT clients for execution.
Limitations
- The maximum number of clients to which a command can be published is 20.
- Command data size is restricted to 4kB.
Generic Errors
The following generic error codes (with status codes) can occur at the operations of this API. Generic error codes are prefixed with 'mdsp.core.generic.'.
- missingParameter (400)
- invalidParameter (400)
- missingRequestBody (400)
- invalidRequestBody (400)
- unauthorized (401)
- forbidden (403)
- conflict (409)
- preconditionFailed (412)
- unsupportedMediaType (415)
- preconditionRequired (428)
- tooManyRequests (429)
- internalServerError (500)
MQTT Delivery JobManage jobs to publish MQTT commands to clients.
Manage jobs to publish MQTT commands to clients.