Connection Controller Facade

post

Authorizations

accessTokenCookie & spaceHeader

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

application/json

filestring · binaryRequired

Responses

200

OK

*/*

Responseobject

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/connections/import

HTTPcURLJavaScriptPython

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

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections

HTTPcURLJavaScriptPython

GET /api/connections HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-12-18T23:09:57.403Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-18T23:09:57.403Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "owner": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/{connectionId}

HTTPcURLJavaScriptPython

GET /api/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-12-18T23:09:57.403Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-18T23:09:57.403Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "owner": "text"
}

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/{connectionId}/devices

HTTPcURLJavaScriptPython

GET /api/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-12-18T23:09:57.403Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-18T23:09:57.403Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/{connectionId}/devices/{deviceId}

HTTPcURLJavaScriptPython

GET /api/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-12-18T23:09:57.403Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-18T23:09:57.403Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text"
}

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/{connectionId}/devices/{deviceId}/frames

HTTPcURLJavaScriptPython

GET /api/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-12-18T23:09:57.403Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-18T23:09:57.403Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text"
  }
]

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/{connectionId}/devices/{deviceId}/frames/{frameId}

HTTPcURLJavaScriptPython

GET /api/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-12-18T23:09:57.403Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-18T23:09:57.403Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text"
}

get

Authorizations

accessTokenCookie & spaceHeader

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/export

HTTPcURLJavaScriptPython

GET /api/connections/export HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}

get

Authorizations

accessTokenCookie & spaceHeader

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/connections/by-project

HTTPcURLJavaScriptPython

GET /api/connections/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-12-18T23:09:57.403Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-18T23:09:57.403Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "owner": "text"
  }
]

delete

Authorizations

accessTokenCookie & spaceHeader

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/connections/multi/by-ids

HTTPcURLJavaScriptPython

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

No content