Mqtt Connection Controller

get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "cleanSession": true,
  "identifier": "text",
  "useSsl": true,
  "maxDelayInMs": 1,
  "username": "text",
  "keepAliveInMs": 1,
  "password": "text",
  "initialDelayInMs": 1,
  "poolSize": 1,
  "owner": "text"
}
put
Authorizations
Path parameters
connectionIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
projectIdstringOptional
namestring · max: 100Required
protocolstring · enumRequiredPossible values:
ipstring · max: 50Required
dscstring · max: 255Optional
portinteger · int32 · max: 65535Required
cleanSessionbooleanOptional
identifierstring · max: 23Optional
useSslbooleanOptional
maxDelayInMsinteger · int32Optional
usernamestring · max: 50Optional
keepAliveInMsinteger · int32 · max: 65535000Optional
passwordstring · max: 50Optional
initialDelayInMsinteger · int32Optional
poolSizeinteger · int32Optional
ownerstringOptional
Responses
204
No Content
put
PUT /api/protocols/mqtt/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "cleanSession": true,
  "identifier": "text",
  "useSsl": true,
  "maxDelayInMs": 1,
  "username": "text",
  "keepAliveInMs": 1,
  "password": "text",
  "initialDelayInMs": 1,
  "poolSize": 1,
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "baseTopic": "text"
}
put
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
connectionIdstringOptional
baseTopicstringRequired
Responses
204
No Content
put
PUT /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "baseTopic": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "subscribeExpressionCode": "text",
  "publishExpressionId": "text",
  "topic": "text",
  "publishExpressionType": "NONE",
  "qos": 1,
  "publishExpressionCode": "text",
  "subscribeExpressionType": "NONE",
  "subscribeExpressionId": "text"
}
put
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
isWritablebooleanRequired
namestring · max: 100Required
minutesOffsetinteger · int32Optional
isReadablebooleanRequired
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
deviceIdstringOptional
subscribeExpressionCodestringOptional
publishExpressionIdstringOptional
topicstringRequired
publishExpressionTypestring · enumOptionalPossible values:
qosinteger · int32 · max: 2Required
publishExpressionCodestringOptional
subscribeExpressionTypestring · enumOptionalPossible values:
subscribeExpressionIdstringOptional
Responses
204
No Content
put
PUT /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "subscribeExpressionCode": "text",
  "publishExpressionId": "text",
  "topic": "text",
  "publishExpressionType": "NONE",
  "qos": 1,
  "publishExpressionCode": "text",
  "subscribeExpressionType": "NONE",
  "subscribeExpressionId": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "cleanSession": true,
    "identifier": "text",
    "useSsl": true,
    "maxDelayInMs": 1,
    "username": "text",
    "keepAliveInMs": 1,
    "password": "text",
    "initialDelayInMs": 1,
    "poolSize": 1,
    "owner": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
projectIdstringOptional
namestring · max: 100Required
protocolstring · enumRequiredPossible values:
ipstring · max: 50Required
dscstring · max: 255Optional
portinteger · int32 · max: 65535Required
cleanSessionbooleanOptional
identifierstring · max: 23Optional
useSslbooleanOptional
maxDelayInMsinteger · int32Optional
usernamestring · max: 50Optional
keepAliveInMsinteger · int32 · max: 65535000Optional
passwordstring · max: 50Optional
initialDelayInMsinteger · int32Optional
poolSizeinteger · int32Optional
ownerstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/mqtt/connections HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "cleanSession": true,
  "identifier": "text",
  "useSsl": true,
  "maxDelayInMs": 1,
  "username": "text",
  "keepAliveInMs": 1,
  "password": "text",
  "initialDelayInMs": 1,
  "poolSize": 1,
  "owner": "text"
}
{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "cleanSession": true,
  "identifier": "text",
  "useSsl": true,
  "maxDelayInMs": 1,
  "username": "text",
  "keepAliveInMs": 1,
  "password": "text",
  "initialDelayInMs": 1,
  "poolSize": 1,
  "owner": "text"
}
get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "baseTopic": "text"
  }
]
post
Authorizations
Path parameters
connectionIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
dscstring · max: 255Optional
namestring · max: 100Required
connectionIdstringOptional
baseTopicstringRequired
Responses
200
OK
*/*
post
POST /api/protocols/mqtt/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "baseTopic": "text"
}
{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "baseTopic": "text"
}
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "subscribeExpressionCode": "text",
    "publishExpressionId": "text",
    "topic": "text",
    "publishExpressionType": "NONE",
    "qos": 1,
    "publishExpressionCode": "text",
    "subscribeExpressionType": "NONE",
    "subscribeExpressionId": "text"
  }
]
post
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
isWritablebooleanRequired
namestring · max: 100Required
minutesOffsetinteger · int32Optional
isReadablebooleanRequired
dscstring · max: 255Optional
scanTimeFactorinteger · int32Optional
deviceIdstringOptional
subscribeExpressionCodestringOptional
publishExpressionIdstringOptional
topicstringRequired
publishExpressionTypestring · enumOptionalPossible values:
qosinteger · int32 · max: 2Required
publishExpressionCodestringOptional
subscribeExpressionTypestring · enumOptionalPossible values:
subscribeExpressionIdstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/mqtt/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "subscribeExpressionCode": "text",
  "publishExpressionId": "text",
  "topic": "text",
  "publishExpressionType": "NONE",
  "qos": 1,
  "publishExpressionCode": "text",
  "subscribeExpressionType": "NONE",
  "subscribeExpressionId": "text"
}
{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "subscribeExpressionCode": "text",
  "publishExpressionId": "text",
  "topic": "text",
  "publishExpressionType": "NONE",
  "qos": 1,
  "publishExpressionCode": "text",
  "subscribeExpressionType": "NONE",
  "subscribeExpressionId": "text"
}
post
Authorizations
Path parameters
connectionIdstringRequired
Body
prefixstringOptional
suffixstringOptional
deviceTemplateIdstringOptional
Responses
204
No Content
post
POST /api/protocols/mqtt/connections/{connectionId}/devices/generate HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "prefix": "text",
  "suffix": "text",
  "deviceTemplateId": "text"
}
No content
get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/frames HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "subscribeExpressionCode": "text",
    "publishExpressionId": "text",
    "topic": "text",
    "publishExpressionType": "NONE",
    "qos": 1,
    "publishExpressionCode": "text",
    "subscribeExpressionType": "NONE",
    "subscribeExpressionId": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/frames/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "subscribeExpressionCode": "text",
    "publishExpressionId": "text",
    "topic": "text",
    "publishExpressionType": "NONE",
    "qos": 1,
    "publishExpressionCode": "text",
    "subscribeExpressionType": "NONE",
    "subscribeExpressionId": "text"
  }
]
get
Authorizations
Path parameters
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/frame/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "subscribeExpressionCode": "text",
  "publishExpressionId": "text",
  "topic": "text",
  "publishExpressionType": "NONE",
  "qos": 1,
  "publishExpressionCode": "text",
  "subscribeExpressionType": "NONE",
  "subscribeExpressionId": "text"
}
get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/devices HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "baseTopic": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/devices/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "baseTopic": "text"
  }
]
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/device/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-25T11:40:07.826Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-25T11:40:07.826Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "baseTopic": "text"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/mqtt/connections/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-25T11:40:07.826Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-25T11:40:07.826Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "cleanSession": true,
    "identifier": "text",
    "useSsl": true,
    "maxDelayInMs": 1,
    "username": "text",
    "keepAliveInMs": 1,
    "password": "text",
    "initialDelayInMs": 1,
    "poolSize": 1,
    "owner": "text"
  }
]
delete
Authorizations
Query parameters
connectionIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
frameIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/frames/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
deviceIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/protocols/mqtt/connections/devices/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
PreviousMqtt Template ControllerNextModbus Template Controller