Opc Ua Connection Controller

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

{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "encodingType": "Binary",
  "isUsernamePasswordAuthentication": true,
  "isHttpsEnabled": true,
  "username": "text",
  "httpsPort": 1,
  "securityPolicy": "None",
  "timeoutInMs": 1,
  "password": "text",
  "isAnonymousAuthentication": true,
  "securityMode": "None",
  "serverName": "text",
  "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
encodingTypestring · enumOptionalPossible values:
isUsernamePasswordAuthenticationbooleanRequired
isHttpsEnabledbooleanOptional
usernamestringOptional
httpsPortinteger · int32 · max: 65535Optional
securityPolicystring · enumRequiredPossible values:
timeoutInMsinteger · int32 · min: 100Optional
passwordstringOptional
isAnonymousAuthenticationbooleanRequired
securityModestring · enumRequiredPossible values:
serverNamestringOptional
ownerstringOptional
Responses
204
No Content
put
PUT /api/protocols/opc-ua/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "encodingType": "Binary",
  "isUsernamePasswordAuthentication": true,
  "isHttpsEnabled": true,
  "username": "text",
  "httpsPort": 1,
  "securityPolicy": "None",
  "timeoutInMs": 1,
  "password": "text",
  "isAnonymousAuthentication": true,
  "securityMode": "None",
  "serverName": "text",
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/opc-ua/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
Accept: */*

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

{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanType": "Periodic",
  "scanTime": 1,
  "basePath": "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
scanTypestring · enumRequiredPossible values:
scanTimeinteger · int32 · min: 1Required
basePathstringOptional
Responses
204
No Content
put
PUT /api/protocols/opc-ua/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanType": "Periodic",
  "scanTime": 1,
  "basePath": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/opc-ua/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/opc-ua/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "path": "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
pathstringOptional
Responses
204
No Content
put
PUT /api/protocols/opc-ua/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "path": "text"
}
No content
delete
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
204
No Content
delete
DELETE /api/protocols/opc-ua/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

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

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "encodingType": "Binary",
    "isUsernamePasswordAuthentication": true,
    "isHttpsEnabled": true,
    "username": "text",
    "httpsPort": 1,
    "securityPolicy": "None",
    "timeoutInMs": 1,
    "password": "text",
    "isAnonymousAuthentication": true,
    "securityMode": "None",
    "serverName": "text",
    "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
encodingTypestring · enumOptionalPossible values:
isUsernamePasswordAuthenticationbooleanRequired
isHttpsEnabledbooleanOptional
usernamestringOptional
httpsPortinteger · int32 · max: 65535Optional
securityPolicystring · enumRequiredPossible values:
timeoutInMsinteger · int32 · min: 100Optional
passwordstringOptional
isAnonymousAuthenticationbooleanRequired
securityModestring · enumRequiredPossible values:
serverNamestringOptional
ownerstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/opc-ua/connections HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "encodingType": "Binary",
  "isUsernamePasswordAuthentication": true,
  "isHttpsEnabled": true,
  "username": "text",
  "httpsPort": 1,
  "securityPolicy": "None",
  "timeoutInMs": 1,
  "password": "text",
  "isAnonymousAuthentication": true,
  "securityMode": "None",
  "serverName": "text",
  "owner": "text"
}
{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "encodingType": "Binary",
  "isUsernamePasswordAuthentication": true,
  "isHttpsEnabled": true,
  "username": "text",
  "httpsPort": 1,
  "securityPolicy": "None",
  "timeoutInMs": 1,
  "password": "text",
  "isAnonymousAuthentication": true,
  "securityMode": "None",
  "serverName": "text",
  "owner": "text"
}
get
Authorizations
Path parameters
connectionIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanType": "Periodic",
    "scanTime": 1,
    "basePath": "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
scanTypestring · enumRequiredPossible values:
scanTimeinteger · int32 · min: 1Required
basePathstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/opc-ua/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanType": "Periodic",
  "scanTime": 1,
  "basePath": "text"
}
{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanType": "Periodic",
  "scanTime": 1,
  "basePath": "text"
}
get
Authorizations
Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "path": "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
pathstringOptional
Responses
200
OK
*/*
post
POST /api/protocols/opc-ua/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "path": "text"
}
{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "path": "text"
}
post
Authorizations
Path parameters
connectionIdstringRequired
Body
prefixstringOptional
suffixstringOptional
deviceTemplateIdstringOptional
Responses
204
No Content
post
POST /api/protocols/opc-ua/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/opc-ua/connections/frames HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "path": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/frames/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text",
    "path": "text"
  }
]
get
Authorizations
Path parameters
frameIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/frame/{frameId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text",
  "path": "text"
}
get
Authorizations
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/devices HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanType": "Periodic",
    "scanTime": 1,
    "basePath": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/devices/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanType": "Periodic",
    "scanTime": 1,
    "basePath": "text"
  }
]
get
Authorizations
Path parameters
deviceIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/device/{deviceId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T20:38:08.249Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T20:38:08.249Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanType": "Periodic",
  "scanTime": 1,
  "basePath": "text"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/protocols/opc-ua/connections/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T20:38:08.249Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T20:38:08.249Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "encodingType": "Binary",
    "isUsernamePasswordAuthentication": true,
    "isHttpsEnabled": true,
    "username": "text",
    "httpsPort": 1,
    "securityPolicy": "None",
    "timeoutInMs": 1,
    "password": "text",
    "isAnonymousAuthentication": true,
    "securityMode": "None",
    "serverName": "text",
    "owner": "text"
  }
]
delete
Authorizations
Query parameters
connectionIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/protocols/opc-ua/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/opc-ua/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/opc-ua/connections/devices/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
PreviousOpc Ua Template ControllerNextOpc Da Variable Controller