Connection Controller Facade

post
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
Body
filestring · binaryRequired
Responses
200

OK

*/*
Responseobject
post
/api/connections/import
POST /api/connections/import HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses
200

OK

*/*
get
/api/connections
GET /api/connections HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
[
  {
    "creationDate": "2025-11-22T23:40:38.543Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:40:38.543Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "owner": "text"
  }
]
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
connectionIdstringRequired
Responses
200

OK

*/*
get
/api/connections/{connectionId}
GET /api/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{
  "creationDate": "2025-11-22T23:40:38.543Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:40:38.543Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "owner": "text"
}
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
connectionIdstringRequired
Responses
200

OK

*/*
get
/api/connections/{connectionId}/devices
GET /api/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
[
  {
    "creationDate": "2025-11-22T23:40:38.543Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:40:38.543Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text"
  }
]
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200

OK

*/*
get
/api/connections/{connectionId}/devices/{deviceId}
GET /api/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{
  "creationDate": "2025-11-22T23:40:38.543Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:40:38.543Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text"
}
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
connectionIdstringRequired
deviceIdstringRequired
Responses
200

OK

*/*
get
/api/connections/{connectionId}/devices/{deviceId}/frames
GET /api/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
[
  {
    "creationDate": "2025-11-22T23:40:38.543Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:40:38.543Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text"
  }
]
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Path parameters
connectionIdstringRequired
deviceIdstringRequired
frameIdstringRequired
Responses
200

OK

*/*
get
/api/connections/{connectionId}/devices/{deviceId}/frames/{frameId}
GET /api/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{
  "creationDate": "2025-11-22T23:40:38.543Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:40:38.543Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text"
}
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200

OK

*/*
Responseobject
get
/api/connections/export
GET /api/connections/export HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
{}
get
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/connections/by-project
GET /api/connections/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*
[
  {
    "creationDate": "2025-11-22T23:40:38.543Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-11-22T23:40:38.543Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "owner": "text"
  }
]
delete
Authorizations
ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters
connectionIdsstring[]Required
Responses
200

OK

No content

delete
/api/connections/multi/by-ids
DELETE /api/connections/multi/by-ids?connectionIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

Last updated