Ethernet Ip Connection Controller
get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 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
retriesinteger · int32Optional
timeoutInMsinteger · int32 · min: 50Optional
ownerstringOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/ethernet-ip/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 147
{
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 1,
"owner": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
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
scanTimeinteger · int32 · min: 1Required
slotinteger · int32Required
scanTypestring · enumRequiredPossible values:
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "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
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 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
retriesinteger · int32Optional
timeoutInMsinteger · int32 · min: 50Optional
ownerstringOptional
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/ethernet-ip/connections HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 147
{
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 1,
"owner": "text"
}
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 1,
"owner": "text"
}
get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
]
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
scanTimeinteger · int32 · min: 1Required
slotinteger · int32Required
scanTypestring · enumRequiredPossible values:
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/ethernet-ip/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "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
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 131
{
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
post
Authorizations
Path parameters
connectionIdstringRequired
Body
prefixstringOptional
suffixstringOptional
deviceTemplateIdstringOptional
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/protocols/ethernet-ip/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
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/frames HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/frames/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
]
get
Authorizations
Path parameters
frameIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/frame/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"isWritable": true,
"name": "text",
"minutesOffset": 1,
"isReadable": true,
"dsc": "text",
"scanTimeFactor": 1,
"deviceId": "text"
}
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/devices HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/devices/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
]
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/device/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"dsc": "text",
"name": "text",
"connectionId": "text",
"scanTime": 1,
"slot": 1,
"scanType": "Periodic"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/protocols/ethernet-ip/connections/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:03:12.965Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:03:12.965Z",
"id": "text",
"projectId": "text",
"name": "text",
"protocol": "Modbus TCP",
"ip": "text",
"dsc": "text",
"port": 1,
"retries": 1,
"timeoutInMs": 1,
"owner": "text"
}
]
delete
Authorizations
Query parameters
connectionIdsstring[]Required
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
delete
Authorizations
Query parameters
frameIdsstring[]Required
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/frames/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
delete
Authorizations
Query parameters
deviceIdsstring[]Required
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/protocols/ethernet-ip/connections/devices/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*
No content