ZeroKey

MQTT

Get MQTT module settings and active connections.

SecurityOAuth2 or ApiKey
Responses
200

Response success.

Response Schema: application/json
Array
ConnectionID
string

Globally unique identifier for the MQTT connection.

host
string

IP or hostname of the MQTT broker.

port
integer
Default: 8883

Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)

TLS
boolean
Default: true

Indicate if connection is using TLS

CertificateProfileID
string or null

The id of the certificate profile. Required if TLS option is set to true

username
string or null

Username associated with the MQTT broker.

Array of objects

Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.

Array
topic
string

MQTT topic that messages matching the FilterChain should be routed to.

Array of objects (FilterChain)

Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.

401

Unauthorized access, invalid credentials were used.

404

Resource was not found.

get/modules/mqtt
Request samples 
Response samples 
application/json
[
  • {
    }
]
Establish a new MQTT connection
SecurityOAuth2 or ApiKey 
Request 
Request Body schema: application/json
Establish a new MQTT connection


host
string
IP or hostname of the MQTT broker.


 
port
integer
 Default:  8883
Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)


 
TLS
boolean
 Default:  true
Indicate if connection is using TLS 


 
CertificateProfileID
string or null
The id of the certificate profile. Required if TLS option is set to true


 
username
string or null
Username associated with the MQTT broker.


 
password
string or null
Password associated with the MQTT broker.


 
Array of objects
Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.


 
 Array 
topic
string
MQTT topic that messages matching the FilterChain should be routed to.


 
Array of objects (FilterChain) 
Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.


 
Responses 
201
Response success


Response Schema: application/json
ConnectionID
string
Globally unique identifier for the MQTT connection.


 
host
string
IP or hostname of the MQTT broker.


 
port
integer
 Default:  8883
Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)


 
TLS
boolean
 Default:  true
Indicate if connection is using TLS 


 
CertificateProfileID
string or null
The id of the certificate profile. Required if TLS option is set to true


 
username
string or null
Username associated with the MQTT broker.


 
Array of objects
Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.


 
 Array 
topic
string
MQTT topic that messages matching the FilterChain should be routed to.


 
Array of objects (FilterChain) 
Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.


 
400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


422
Invalid data was sent.


post/modules/mqtt
Request samples 
application/json
{
  • "host": "10.20.0.1",
  • "port": 8883,
  • "TLS": true,
  • "CertificateProfileID": "MyCertificateProfileID",
  • "username": "string",
  • "password": "string",
  • "topics": [
    ]
}
Response samples 
application/json
{
  • "ConnectionID": "0b214de7-8958-4956-8eed-28f9ba2c47c6",
  • "host": "10.20.0.1",
  • "port": 8883,
  • "TLS": true,
  • "CertificateProfileID": "MyCertificateProfileID",
  • "username": "string",
  • "topics": [
    ]
}
Get MQTT connection information.
SecurityOAuth2 or ApiKey 
Request 
path Parameters
ConnectionID
required
string
ID of the MQTT connection


 
 Example:  0b214de7-8958-4956-8eed-28f9ba2c47c6
Responses 
200
Response success.


Response Schema: application/json
 Array 
ConnectionID
string
Globally unique identifier for the MQTT connection.


 
host
string
IP or hostname of the MQTT broker.


 
port
integer
 Default:  8883
Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)


 
TLS
boolean
 Default:  true
Indicate if connection is using TLS 


 
CertificateProfileID
string or null
The id of the certificate profile. Required if TLS option is set to true


 
username
string or null
Username associated with the MQTT broker.


 
Array of objects
Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.


 
 Array 
topic
string
MQTT topic that messages matching the FilterChain should be routed to.


 
Array of objects (FilterChain) 
Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.


 
401
Unauthorized access, invalid credentials were used.


404
Resource was not found.


get/modules/mqtt/{ConnectionID}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Update MQTT connection settings.
SecurityOAuth2 or ApiKey 
Request 
path Parameters
ConnectionID
required
string
ID of the MQTT connection


 
 Example:  0b214de7-8958-4956-8eed-28f9ba2c47c6
Request Body schema: application/json
Change the settings of a MQTT connection


host
string
IP or hostname of the MQTT broker.


 
port
integer
 Default:  8883
Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)


 
TLS
boolean
 Default:  true
Indicate if connection is using TLS 


 
CertificateProfileID
string or null
The id of the certificate profile. Required if TLS option is set to true


 
username
string or null
Username associated with the MQTT broker.


 
password
string or null
Password associated with the MQTT broker.


 
Array of objects
Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.


 
 Array 
topic
string
MQTT topic that messages matching the FilterChain should be routed to.


 
Array of objects (FilterChain) 
Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.


 
Responses 
200
Response success


Response Schema: application/json
ConnectionID
string
Globally unique identifier for the MQTT connection.


 
host
string
IP or hostname of the MQTT broker.


 
port
integer
 Default:  8883
Port of the MQTT service. (IANA registered ports (1883 unencrypted, 8883 TLS)


 
TLS
boolean
 Default:  true
Indicate if connection is using TLS 


 
CertificateProfileID
string or null
The id of the certificate profile. Required if TLS option is set to true


 
username
string or null
Username associated with the MQTT broker.


 
Array of objects
Array of topics and FilterChains which determine which matching Event messages are forwarded to which MQTT topics.


 
 Array 
topic
string
MQTT topic that messages matching the FilterChain should be routed to.


 
Array of objects (FilterChain) 
Array of FilterChain objects. Each FilterChain object in the array is compared against the next with a logical OR operator, while the FilterChain objects within the Children property are compared with the logical AND operator.


 
400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


404
Resource was not found.


422
Invalid data was sent.


put/modules/mqtt/{ConnectionID}
Request samples 
application/json
{
  • "host": "10.20.0.1",
  • "port": 8883,
  • "TLS": true,
  • "CertificateProfileID": "MyCertificateProfileID",
  • "username": "string",
  • "password": "string",
  • "topics": [
    ]
}
Response samples 
application/json
{
  • "ConnectionID": "0b214de7-8958-4956-8eed-28f9ba2c47c6",
  • "host": "10.20.0.1",
  • "port": 8883,
  • "TLS": true,
  • "CertificateProfileID": "MyCertificateProfileID",
  • "username": "string",
  • "topics": [
    ]
}
Remove MQTT connection.
SecurityOAuth2 or ApiKey 
Request 
path Parameters
ConnectionID
required
string
ID of the MQTT connection


 
 Example:  0b214de7-8958-4956-8eed-28f9ba2c47c6
Responses 
200
Success response.


Response Schema: application/json
status
integer  [ 200 .. 202 ] 
The HTTP status code.


 
success
boolean
 
401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


404
Resource was not found.


delete/modules/mqtt/{ConnectionID}
Request samples 
Response samples 
application/json
{
  • "status": 200,
  • "success": true
}
Get MQTT certificate profiles.
SecurityOAuth2 or ApiKey 
Responses 
200
Response success.


Response Schema: application/json
 Array 
ID
string
The ID of the certificate profile


 
name
string
The name of the certificate profile


 
401
Unauthorized access, invalid credentials were used.


404
Resource was not found.


get/modules/mqtt/certificate
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a new MQTT certificate profile
SecurityOAuth2 or ApiKey 
Request 
Request Body schema: application/json
Create a new MQTT certificate profile


name
string
The name of the certificate profile


 
ca
string
Server certificate (CA). This field is required


 
client
string or null
Client certificate


 
password
string or null
Client key


 
Responses 
200
Response success


Response Schema: application/json
ID
string
The ID of the certificate profile


 
name
string
The name of the certificate profile


 
400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


422
Invalid data was sent.


post/modules/mqtt/certificate
Request samples 
application/json
{
  • "name": "Sample Certificate Name",
  • "ca": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBekNDQXV1Z0F3SUJBZ0lVQlkxaGxDR3ZkajROaEJYa1ovdUxVWk5JTEF3d0RRWUpLb1pJaHZjTkFRRUwKQlFBd2daQXhDekFKQmdOVkJBWVRBa2RDTVJjd0ZRWURWUVFJREE1VmJtbDBaV1FnUzJsdVoyUnZiVEVPTUF3RwpBMVVFQnd3RlJHVnlZbmt4RWpBUUJnTlZCQW9NQ1UxdmMzRjFhWFIwYnpFTE1Ba0dBMVVFQ3d3Q1EwRXhGakFVCkJnTlZCQU1NRFcxdmMzRjFhWFIwYnk1dmNtY3hIekFkQmdrcWhraUc5dzBCQ1FFV0VISnZaMlZ5UUdGMFkyaHYKYnk1dmNtY3dIaGNOTWpBd05qQTVNVEV3TmpNNVdoY05NekF3TmpBM01URXdOak01V2pDQmtERUxNQWtHQTFVRQpCaE1DUjBJeEZ6QVZCZ05WQkFnTURsVnVhWFJsWkNCTGFXNW5aRzl0TVE0d0RBWURWUVFIREFWRVpYSmllVEVTCk1CQUdBMVVFQ2d3SlRXOXpjWFZwZEhSdk1Rc3dDUVlEVlFRTERBSkRRVEVXTUJRR0ExVUVBd3dOYlc5emNYVnAKZEhSdkxtOXlaekVmTUIwR0NTcUdTSWIzRFFFSkFSWVFjbTluWlhKQVlYUmphRzl2TG05eVp6Q0NBU0l3RFFZSgpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFNRTBIS21JemZUT3drS0xUM1RISGUrT2JkaXphbVBnClVabUQ2NFRmM3pKZE5lWUdZbjRDRVhieVA2ZnkzdFdjOFMyYm9XNmR6ckg4U2RGZjl1bzMyMEdKQTlCN1UxRlcKVGUzeGRhL0xtM0pGZmFIamtXdzdqQndjYXVRWmpwR0lOSGFwSFJscGlDWnNxdUF0aE9neFc5U2dEZ1lsR3pFQQpzMDZwa0VGaU13K3FEZkxvL3N4RktCNnZRbEZla01lQ3ltakxDYk53UEp5cXloRm1QV3dpby9QRE1ydUJUelBICjNjaW9CbnJKV0tYYzNPalhkTEdGSk9majdwUDBqL2RyMkxINzJlU3Z2M1BRUUZsOTBDWlBGaHJDVWNSSFNTeG8KRTZ5akdPZG56N2Y2UHZlTElCNTc0a1FPUnd0OGVQbjB5aWRyVEMxaWN0aWtFRDNuSFloTVVPVUNBd0VBQWFOVApNRkV3SFFZRFZSME9CQllFRlBWVjZ4QlVGUGlHS0R5bzVWMytIYmg0TjlZU01COEdBMVVkSXdRWU1CYUFGUFZWCjZ4QlVGUGlHS0R5bzVWMytIYmg0TjlZU01BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUwKQlFBRGdnRUJBR2E5a1MyMU43MFRoTTYvSGo5RDdtYlZ4S0xCalZXZTJUUHNHZmJsM3JFRGZaK09LUloyajZBQwo2cjdqYjRUWk8zZHpGMnA2ZGdicmxVNzFZLzRLMFRkeklqUmozY1EzS1NtNDFKdlVRMGhaL2MwNGlHRGcveFdmCitwcDU4bmZQQVl3dWVycnVQTldtbFN0V0FYZjBVVHFSdGc0aFFEV0J1VUZESlR1V3V1QnZFWHVkejc0ZWgvd0sKc013ZnUxSEZ2ank1WjBpTURVOFBVRGVwalZvbE9DdWU5YXNobFM0RUI1SUVDZFNSMlRJdG5BSWlJd2lteDgzOQpMZFVkUnVkYWZNdTVUNVhtYTE4Mk9DMC91L3hSbEVtK3R2S0dHbWZGY04wcGlxVmw4T3JTUEJnSWxiKzFJS0pFCm0vWHJpV3IvQ3E0aC9KZkI3TlRzZXpWc2xna0Jhb1U9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K",
  • "client": "MIIJ6QIBAzCCCa8GCSqGSIb3DQEHAaCCCaAEggmcMIIJmDCCBE8GCSqGSIb3DQEHBqCCBEAwggQ8AgEAMIIENQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQII49GmPJwSDECAggAgIIECGYngedd9fSYsc56TNhVsiuXLiTjlR4IPxfX7Y3KbwIc1JllDV6iZbweDP+BMo/LKTAKsCuuQ7LfVqzDTC68+FgUelpeGNHcwK7TKnw8X4q7uGkJHn0ZDWjwyfzige0TaUIuLTV7HxTJBlb9bWbdoaM7F9ksYBeBiCHjkQ+c8mUCC/4AsGlDSR80Tr/rxPHAgS3NceLbM2r8SaQudrK18EbUgVPrBEpwdIjKtRwdGpqSDP14SmgbRUPJEtrp7aj1ijz5ZiwghBSI/2lhCoQXbGUMpnMA0XTIze17T6fntMAV+Ic/UmaIgVCwbveDwsymm+vfPOkzIbnK3lj7rMYxzDJYkloh/rk9bYuJl7Y0IzYI8KhAOSf7ujpRqNvsaNSII3PN1/G3mfONnjQzifTsnvLOdOQzp34nyeLKY2Yes/Pd6hLG8PQAJJsgExWl5RGB3yyuBNeFPeXvGnP1LiOwPVdvfR7i/b1D7A7DjucIEdHdt7FNJKzdBfqugLnaMtaPsnjerTvOqwbc5Vwuvn+ECE2d2N5Z6OwN8AcFc3yGceHXHT+n+tnkeTe+JYe91qBo0hTkX8TGa7ot/w4uHSIhxi69wbBenGR/geXdoqLHGCMYU9Cx9+DvxYMe1RFs8Eh0UODTbGXdd0qPzv6yVhK93yimSJC1I0gNoUXkUbwzeKvA17EF428jND6P3uHG2AtOH7n/qJe7aTNb89w/d40GdZqmYngVPMc/MQWzg5UIDAFHuBUs5HFWG8+yQL/tOH48bNEm7fWGiRuHJVwH+OU8IMTXVyTdjYo/pSEvk0RefwqAw4AOY1fDSRoE82s9lxyB0YyFjRtG6wdemdwfuFoBzOzDGdUy0HofoGbIk8mwdQ79myPKWmQfBSGUOlIEWUpgtk5GLUhlyL6qf0zhJyQVapmSM1R1suoImVh3kXE6bj6DB7noSOUFiz4zKzKZKGSkeDTcpCjr2l05zmoxnNPd2F4v6Zj74CRY/tHPfV4KbaVn83G2gyGBWiTxg/Lfi8Hk40rUL5K0m/DUFjFmKDrYnPHDSbXK11NQ9Xk9tVUHEffLgnK3JUgxvSKwq1KIfEl0kGB796wDbG1DbsiduqISIqTBztRzudTZ0UxNnLxr3BNaDwknmnj/qA7cNarrQEgbTp7cGdRnED9rx/CFPAvLILNE1bsPEaoAHVGh7kqV+al2o1DN+SDsz5fG3JTIqRnQlHGj8dbCngkLLDCxGkza4guR23vinPuov39Q75tESKpSRRl6NW724dcajPy60y08MUe6z02VvQDMU5mqvYwO4AlTjSfbeTIDmRTWzhzdiB63VO71oY4WvYsM4chUCvUMtVAIxVWP90cjJ+7nDMZnNoQncCYMk3upHDCCBUEGCSqGSIb3DQEHAaCCBTIEggUuMIIFKjCCBSYGCyqGSIb3DQEMCgECoIIE7jCCBOowHAYKKoZIhvcNAQwBAzAOBAgftiT8NtasxQICCAAEggTIaqsjIHc6I7j/++W4cKFuWrr6HDu4vlO0L4trDRwUvnF2IgKraIPhKHeKxiuKnD+q5OzdSYKz0PTk315ZD39pB+l6UROatzeRYknnluor5sO4T83nebsGJuKQGQ8ikQmGmRHgFnI/d7DYvNmPrpDvHs35bAAui2tVpWU340dD5H/L+PmU9A2S4vozOlA+DSeYwLpu6rXvjTNw4YlJl9EJXZ1Ji3WdXMdyheyT21ayxhl/Wejum2dPC9P3L2/dHaF7wXqk1smHAyxBZUdbev7TwYKQrmqlP3cMEBHc0N0tm4cfbH/MXE2wFDDNM7BG//zKTBAS0G1QdnofLlxU/P85AyaBWhL8hxC6+6m/M/YwcEK5if1l3c6ZPV83DwMtn1fVMXdtlno0pJWsB1dv1D1vz4f7ez81P5wgOW0arbbJSqevItscPIFhEmWh1DOFklwDJZSCF/lUg0vmYjacYW6vjeRu3+tY1l0dg2eTJID3lSIhDpb89Z85UuLuS7cTSWMVKWQzl3HUECClXHDAJcal7Yujwuo6kucOqWdjJqZOsjrbxNbKjO26Cv8Gk218L3kREL/M7R4FTcnID8j7wpAUJdfG1yF6nj74N78AZ6SL4bQjmfb1W5l6QJzmeG1Ioqqs9Qg50qPkmTXFjx8cmh5dKo3FVsv8oGEGiqFDjSAaCoBKKQEv3pL/1m9e80m+oY6MGXxxih/+s4Np5oWndqBz5cw+TWPSNy89oBby5HcRzAOpPMScMV76r0UReLRQdrH12boVKu8l4k4xkWYWcHxI0lI8MFDPx+7wHFARsKD/8OMdIdmQ/5cNC/dvqsUgMdX7RU3IUMgWU5bRJIaNe3pmYjkEMKRM5VFmPfsZNAOQXwCHTld8D31R2kANpnrEdDUC78TPiBRcNoezaYtejVy83APCg4OuTZgWdS9vomYIAD/zDuleNty51bIc2SuF4dLz7Ob/tdzhlcWQJii4bOx63nCMOT5Nyz1s+BU23N2OjFaACWiJubjCX5OGVSWdc7721E4fa/ff28qMPaGTjvI2Hu2Gg2XEp2zy4ypnwmdohJInYz8ZyEwip6+SmvzdBvwrZvyFSZuolxRy9gnCB3fWcN3gPJzm6fvE3LAMSNBEfx/wOirnI0cCHs2aoIC8GNWej8UCbobiBmTR174zU7/AqwS1coAqOOPeOzqIIEQ1KalR7Wk/TNlGJzQaDNpeE5kWXLDW5owtJzSBjCg53zhrzsk/r1uz5zHnqiUPYk+DWTgKILNduz7jo0xp1wzVJN1cct0NSyPHxD6mnENC01eWpZCoCdsCD/E2RHYenNc9tCbH+h0gxSKAb2Uo1yHeGjS705egYeJ7tTW+ZYtEW+JgzV0OcLP8g4CPF2rckZ9DPuQVMQZEDwd5MSvMB98YwcBX0im6AQ1KXC5ZeKFfeS1DF+bicBCVoi91Wu7oN7Jp1lYjtBJICefRUka+pE3a8SS+F0yakaDc9pdwNxeTvtAK84McsfNdMtpjS1ZB6BYbN5aMWZ81h9OLC5i7BnGaiyA3D3XJqbPfxhzxT3d8XSIzkDxk2xVjM9qoauLLsFUXCPfdi57VHdl+tbLZuDBfybC4LgTwVZX3G5ddia0nfl3gBib//+K1FEqOMSUwIwYJKoZIhvcNAQkVMRYEFESIddEilRQQtPWUp8hC7BVwSZEvMDEwITAJBgUrDgMCGgUABBSkpTU0g1mlwl0zN1gqNFARf5NTMQQIB20SeOY1JFkCAggA",
  • "password": "userpassword"
}
Response samples 
application/json
{
  • "ID": "38ddf769-72a6-45c4-a782-efdda66a9a1b",
  • "name": "Sample Certificate Name"
}
Update MQTT connection settings.
SecurityOAuth2 or ApiKey 
Request 
path Parameters
CertificateProfileID
required
string
ID of the MQTT certificate profile


 
 Example:  0b214de7-8958-4956-8eed-28f9ba2c47c6
Request Body schema: application/json
Update the settings of a MQTT certificate profile


name
string
The name of the certificate profile


 
ca
string
Server certificate (CA). This field is required


 
client
string or null
Client certificate


 
password
string or null
Client key


 
Responses 
200
Response success


Response Schema: application/json
ID
string
The ID of the certificate profile


 
name
string
The name of the certificate profile


 
400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


404
Resource was not found.


422
Invalid data was sent.


put/modules/mqtt/certificate/{CertificateProfileID}
Request samples 
application/json
{
  • "name": "Sample Certificate Name",
  • "ca": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBekNDQXV1Z0F3SUJBZ0lVQlkxaGxDR3ZkajROaEJYa1ovdUxVWk5JTEF3d0RRWUpLb1pJaHZjTkFRRUwKQlFBd2daQXhDekFKQmdOVkJBWVRBa2RDTVJjd0ZRWURWUVFJREE1VmJtbDBaV1FnUzJsdVoyUnZiVEVPTUF3RwpBMVVFQnd3RlJHVnlZbmt4RWpBUUJnTlZCQW9NQ1UxdmMzRjFhWFIwYnpFTE1Ba0dBMVVFQ3d3Q1EwRXhGakFVCkJnTlZCQU1NRFcxdmMzRjFhWFIwYnk1dmNtY3hIekFkQmdrcWhraUc5dzBCQ1FFV0VISnZaMlZ5UUdGMFkyaHYKYnk1dmNtY3dIaGNOTWpBd05qQTVNVEV3TmpNNVdoY05NekF3TmpBM01URXdOak01V2pDQmtERUxNQWtHQTFVRQpCaE1DUjBJeEZ6QVZCZ05WQkFnTURsVnVhWFJsWkNCTGFXNW5aRzl0TVE0d0RBWURWUVFIREFWRVpYSmllVEVTCk1CQUdBMVVFQ2d3SlRXOXpjWFZwZEhSdk1Rc3dDUVlEVlFRTERBSkRRVEVXTUJRR0ExVUVBd3dOYlc5emNYVnAKZEhSdkxtOXlaekVmTUIwR0NTcUdTSWIzRFFFSkFSWVFjbTluWlhKQVlYUmphRzl2TG05eVp6Q0NBU0l3RFFZSgpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFNRTBIS21JemZUT3drS0xUM1RISGUrT2JkaXphbVBnClVabUQ2NFRmM3pKZE5lWUdZbjRDRVhieVA2ZnkzdFdjOFMyYm9XNmR6ckg4U2RGZjl1bzMyMEdKQTlCN1UxRlcKVGUzeGRhL0xtM0pGZmFIamtXdzdqQndjYXVRWmpwR0lOSGFwSFJscGlDWnNxdUF0aE9neFc5U2dEZ1lsR3pFQQpzMDZwa0VGaU13K3FEZkxvL3N4RktCNnZRbEZla01lQ3ltakxDYk53UEp5cXloRm1QV3dpby9QRE1ydUJUelBICjNjaW9CbnJKV0tYYzNPalhkTEdGSk9majdwUDBqL2RyMkxINzJlU3Z2M1BRUUZsOTBDWlBGaHJDVWNSSFNTeG8KRTZ5akdPZG56N2Y2UHZlTElCNTc0a1FPUnd0OGVQbjB5aWRyVEMxaWN0aWtFRDNuSFloTVVPVUNBd0VBQWFOVApNRkV3SFFZRFZSME9CQllFRlBWVjZ4QlVGUGlHS0R5bzVWMytIYmg0TjlZU01COEdBMVVkSXdRWU1CYUFGUFZWCjZ4QlVGUGlHS0R5bzVWMytIYmg0TjlZU01BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUwKQlFBRGdnRUJBR2E5a1MyMU43MFRoTTYvSGo5RDdtYlZ4S0xCalZXZTJUUHNHZmJsM3JFRGZaK09LUloyajZBQwo2cjdqYjRUWk8zZHpGMnA2ZGdicmxVNzFZLzRLMFRkeklqUmozY1EzS1NtNDFKdlVRMGhaL2MwNGlHRGcveFdmCitwcDU4bmZQQVl3dWVycnVQTldtbFN0V0FYZjBVVHFSdGc0aFFEV0J1VUZESlR1V3V1QnZFWHVkejc0ZWgvd0sKc013ZnUxSEZ2ank1WjBpTURVOFBVRGVwalZvbE9DdWU5YXNobFM0RUI1SUVDZFNSMlRJdG5BSWlJd2lteDgzOQpMZFVkUnVkYWZNdTVUNVhtYTE4Mk9DMC91L3hSbEVtK3R2S0dHbWZGY04wcGlxVmw4T3JTUEJnSWxiKzFJS0pFCm0vWHJpV3IvQ3E0aC9KZkI3TlRzZXpWc2xna0Jhb1U9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K",
  • "client": "MIIJ6QIBAzCCCa8GCSqGSIb3DQEHAaCCCaAEggmcMIIJmDCCBE8GCSqGSIb3DQEHBqCCBEAwggQ8AgEAMIIENQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQII49GmPJwSDECAggAgIIECGYngedd9fSYsc56TNhVsiuXLiTjlR4IPxfX7Y3KbwIc1JllDV6iZbweDP+BMo/LKTAKsCuuQ7LfVqzDTC68+FgUelpeGNHcwK7TKnw8X4q7uGkJHn0ZDWjwyfzige0TaUIuLTV7HxTJBlb9bWbdoaM7F9ksYBeBiCHjkQ+c8mUCC/4AsGlDSR80Tr/rxPHAgS3NceLbM2r8SaQudrK18EbUgVPrBEpwdIjKtRwdGpqSDP14SmgbRUPJEtrp7aj1ijz5ZiwghBSI/2lhCoQXbGUMpnMA0XTIze17T6fntMAV+Ic/UmaIgVCwbveDwsymm+vfPOkzIbnK3lj7rMYxzDJYkloh/rk9bYuJl7Y0IzYI8KhAOSf7ujpRqNvsaNSII3PN1/G3mfONnjQzifTsnvLOdOQzp34nyeLKY2Yes/Pd6hLG8PQAJJsgExWl5RGB3yyuBNeFPeXvGnP1LiOwPVdvfR7i/b1D7A7DjucIEdHdt7FNJKzdBfqugLnaMtaPsnjerTvOqwbc5Vwuvn+ECE2d2N5Z6OwN8AcFc3yGceHXHT+n+tnkeTe+JYe91qBo0hTkX8TGa7ot/w4uHSIhxi69wbBenGR/geXdoqLHGCMYU9Cx9+DvxYMe1RFs8Eh0UODTbGXdd0qPzv6yVhK93yimSJC1I0gNoUXkUbwzeKvA17EF428jND6P3uHG2AtOH7n/qJe7aTNb89w/d40GdZqmYngVPMc/MQWzg5UIDAFHuBUs5HFWG8+yQL/tOH48bNEm7fWGiRuHJVwH+OU8IMTXVyTdjYo/pSEvk0RefwqAw4AOY1fDSRoE82s9lxyB0YyFjRtG6wdemdwfuFoBzOzDGdUy0HofoGbIk8mwdQ79myPKWmQfBSGUOlIEWUpgtk5GLUhlyL6qf0zhJyQVapmSM1R1suoImVh3kXE6bj6DB7noSOUFiz4zKzKZKGSkeDTcpCjr2l05zmoxnNPd2F4v6Zj74CRY/tHPfV4KbaVn83G2gyGBWiTxg/Lfi8Hk40rUL5K0m/DUFjFmKDrYnPHDSbXK11NQ9Xk9tVUHEffLgnK3JUgxvSKwq1KIfEl0kGB796wDbG1DbsiduqISIqTBztRzudTZ0UxNnLxr3BNaDwknmnj/qA7cNarrQEgbTp7cGdRnED9rx/CFPAvLILNE1bsPEaoAHVGh7kqV+al2o1DN+SDsz5fG3JTIqRnQlHGj8dbCngkLLDCxGkza4guR23vinPuov39Q75tESKpSRRl6NW724dcajPy60y08MUe6z02VvQDMU5mqvYwO4AlTjSfbeTIDmRTWzhzdiB63VO71oY4WvYsM4chUCvUMtVAIxVWP90cjJ+7nDMZnNoQncCYMk3upHDCCBUEGCSqGSIb3DQEHAaCCBTIEggUuMIIFKjCCBSYGCyqGSIb3DQEMCgECoIIE7jCCBOowHAYKKoZIhvcNAQwBAzAOBAgftiT8NtasxQICCAAEggTIaqsjIHc6I7j/++W4cKFuWrr6HDu4vlO0L4trDRwUvnF2IgKraIPhKHeKxiuKnD+q5OzdSYKz0PTk315ZD39pB+l6UROatzeRYknnluor5sO4T83nebsGJuKQGQ8ikQmGmRHgFnI/d7DYvNmPrpDvHs35bAAui2tVpWU340dD5H/L+PmU9A2S4vozOlA+DSeYwLpu6rXvjTNw4YlJl9EJXZ1Ji3WdXMdyheyT21ayxhl/Wejum2dPC9P3L2/dHaF7wXqk1smHAyxBZUdbev7TwYKQrmqlP3cMEBHc0N0tm4cfbH/MXE2wFDDNM7BG//zKTBAS0G1QdnofLlxU/P85AyaBWhL8hxC6+6m/M/YwcEK5if1l3c6ZPV83DwMtn1fVMXdtlno0pJWsB1dv1D1vz4f7ez81P5wgOW0arbbJSqevItscPIFhEmWh1DOFklwDJZSCF/lUg0vmYjacYW6vjeRu3+tY1l0dg2eTJID3lSIhDpb89Z85UuLuS7cTSWMVKWQzl3HUECClXHDAJcal7Yujwuo6kucOqWdjJqZOsjrbxNbKjO26Cv8Gk218L3kREL/M7R4FTcnID8j7wpAUJdfG1yF6nj74N78AZ6SL4bQjmfb1W5l6QJzmeG1Ioqqs9Qg50qPkmTXFjx8cmh5dKo3FVsv8oGEGiqFDjSAaCoBKKQEv3pL/1m9e80m+oY6MGXxxih/+s4Np5oWndqBz5cw+TWPSNy89oBby5HcRzAOpPMScMV76r0UReLRQdrH12boVKu8l4k4xkWYWcHxI0lI8MFDPx+7wHFARsKD/8OMdIdmQ/5cNC/dvqsUgMdX7RU3IUMgWU5bRJIaNe3pmYjkEMKRM5VFmPfsZNAOQXwCHTld8D31R2kANpnrEdDUC78TPiBRcNoezaYtejVy83APCg4OuTZgWdS9vomYIAD/zDuleNty51bIc2SuF4dLz7Ob/tdzhlcWQJii4bOx63nCMOT5Nyz1s+BU23N2OjFaACWiJubjCX5OGVSWdc7721E4fa/ff28qMPaGTjvI2Hu2Gg2XEp2zy4ypnwmdohJInYz8ZyEwip6+SmvzdBvwrZvyFSZuolxRy9gnCB3fWcN3gPJzm6fvE3LAMSNBEfx/wOirnI0cCHs2aoIC8GNWej8UCbobiBmTR174zU7/AqwS1coAqOOPeOzqIIEQ1KalR7Wk/TNlGJzQaDNpeE5kWXLDW5owtJzSBjCg53zhrzsk/r1uz5zHnqiUPYk+DWTgKILNduz7jo0xp1wzVJN1cct0NSyPHxD6mnENC01eWpZCoCdsCD/E2RHYenNc9tCbH+h0gxSKAb2Uo1yHeGjS705egYeJ7tTW+ZYtEW+JgzV0OcLP8g4CPF2rckZ9DPuQVMQZEDwd5MSvMB98YwcBX0im6AQ1KXC5ZeKFfeS1DF+bicBCVoi91Wu7oN7Jp1lYjtBJICefRUka+pE3a8SS+F0yakaDc9pdwNxeTvtAK84McsfNdMtpjS1ZB6BYbN5aMWZ81h9OLC5i7BnGaiyA3D3XJqbPfxhzxT3d8XSIzkDxk2xVjM9qoauLLsFUXCPfdi57VHdl+tbLZuDBfybC4LgTwVZX3G5ddia0nfl3gBib//+K1FEqOMSUwIwYJKoZIhvcNAQkVMRYEFESIddEilRQQtPWUp8hC7BVwSZEvMDEwITAJBgUrDgMCGgUABBSkpTU0g1mlwl0zN1gqNFARf5NTMQQIB20SeOY1JFkCAggA",
  • "password": "userpassword"
}
Response samples 
application/json
{
  • "ID": "38ddf769-72a6-45c4-a782-efdda66a9a1b",
  • "name": "Sample Certificate Name"
}
Remove MQTT certificate profile by ID.
SecurityOAuth2 or ApiKey 
Request 
path Parameters
CertificateProfileID
required
string
ID of the MQTT certificate profile


 
 Example:  0b214de7-8958-4956-8eed-28f9ba2c47c6
Responses 
200
Success response.


Response Schema: application/json
status
integer  [ 200 .. 202 ] 
The HTTP status code.


 
success
boolean
 
401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


404
Resource was not found.


delete/modules/mqtt/certificate/{CertificateProfileID}
Request samples 
Response samples 
application/json
{
  • "status": 200,
  • "success": true
}
➔ Next to Open Protocol