Ethernet Ip Connection Controller

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/protocols/ethernet-ip/connections/{connectionId}

HTTPcURLJavaScriptPython

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

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "retries": 1,
  "timeoutInMs": 1,
  "owner": "text"
}

put

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

Body

application/json

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

/api/protocols/ethernet-ip/connections/{connectionId}

HTTPcURLJavaScriptPython

PUT /api/protocols/ethernet-ip/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

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

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/{connectionId}

HTTPcURLJavaScriptPython

DELETE /api/protocols/ethernet-ip/connections/{connectionId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}

HTTPcURLJavaScriptPython

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

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanTime": 1,
  "slot": 1,
  "scanType": "Periodic"
}

put

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

Body

application/json

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

/api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}

HTTPcURLJavaScriptPython

PUT /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

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

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}

HTTPcURLJavaScriptPython

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

No content

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/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId}

HTTPcURLJavaScriptPython

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

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text"
}

put

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

Body

application/json

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

/api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId}

HTTPcURLJavaScriptPython

PUT /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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

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

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames/{frameId}

HTTPcURLJavaScriptPython

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

No content

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/protocols/ethernet-ip/connections

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "retries": 1,
    "timeoutInMs": 1,
    "owner": "text"
  }
]

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

Body

application/json

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

/api/protocols/ethernet-ip/connections

HTTPcURLJavaScriptPython

POST /api/protocols/ethernet-ip/connections HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "projectId": "text",
  "name": "text",
  "protocol": "Modbus TCP",
  "ip": "text",
  "dsc": "text",
  "port": 1,
  "retries": 1,
  "timeoutInMs": 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/protocols/ethernet-ip/connections/{connectionId}/devices

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanTime": 1,
    "slot": 1,
    "scanType": "Periodic"
  }
]

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

Path parameters

connectionIdstringRequired

Body

application/json

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

/api/protocols/ethernet-ip/connections/{connectionId}/devices

HTTPcURLJavaScriptPython

POST /api/protocols/ethernet-ip/connections/{connectionId}/devices HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanTime": 1,
  "slot": 1,
  "scanType": "Periodic"
}

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanTime": 1,
  "slot": 1,
  "scanType": "Periodic"
}

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/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "isWritable": true,
    "name": "text",
    "minutesOffset": 1,
    "isReadable": true,
    "dsc": "text",
    "scanTimeFactor": 1,
    "deviceId": "text"
  }
]

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

Path parameters

connectionIdstringRequired

deviceIdstringRequired

Body

application/json

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

/api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames

HTTPcURLJavaScriptPython

POST /api/protocols/ethernet-ip/connections/{connectionId}/devices/{deviceId}/frames HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "isWritable": true,
  "name": "text",
  "minutesOffset": 1,
  "isReadable": true,
  "dsc": "text",
  "scanTimeFactor": 1,
  "deviceId": "text"
}

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

Path parameters

connectionIdstringRequired

Body

application/json

prefixstringOptional

suffixstringOptional

deviceTemplateIdstringOptional

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/protocols/ethernet-ip/connections/{connectionId}/devices/generate

HTTPcURLJavaScriptPython

POST /api/protocols/ethernet-ip/connections/{connectionId}/devices/generate HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "prefix": "text",
  "suffix": "text",
  "deviceTemplateId": "text"
}

No content

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/protocols/ethernet-ip/connections/frames

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "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

projectIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/protocols/ethernet-ip/connections/frames/by-project

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "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

frameIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/protocols/ethernet-ip/connections/frame/{frameId}

HTTPcURLJavaScriptPython

GET /api/protocols/ethernet-ip/connections/frame/{frameId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "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

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/protocols/ethernet-ip/connections/devices

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanTime": 1,
    "slot": 1,
    "scanType": "Periodic"
  }
]

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/protocols/ethernet-ip/connections/devices/by-project

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "dsc": "text",
    "name": "text",
    "connectionId": "text",
    "scanTime": 1,
    "slot": 1,
    "scanType": "Periodic"
  }
]

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

deviceIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/protocols/ethernet-ip/connections/device/{deviceId}

HTTPcURLJavaScriptPython

GET /api/protocols/ethernet-ip/connections/device/{deviceId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-12-17T18:03:05.037Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-12-17T18:03:05.037Z",
  "id": "text",
  "dsc": "text",
  "name": "text",
  "connectionId": "text",
  "scanTime": 1,
  "slot": 1,
  "scanType": "Periodic"
}

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/protocols/ethernet-ip/connections/by-project

HTTPcURLJavaScriptPython

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

[
  {
    "creationDate": "2025-12-17T18:03:05.037Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-12-17T18:03:05.037Z",
    "id": "text",
    "projectId": "text",
    "name": "text",
    "protocol": "Modbus TCP",
    "ip": "text",
    "dsc": "text",
    "port": 1,
    "retries": 1,
    "timeoutInMs": 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

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/multi/by-ids

HTTPcURLJavaScriptPython

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

No content

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

frameIdsstring[]Required

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/frames/multi/by-ids

HTTPcURLJavaScriptPython

DELETE /api/protocols/ethernet-ip/connections/frames/multi/by-ids?frameIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

deviceIdsstring[]Required

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/protocols/ethernet-ip/connections/devices/multi/by-ids

HTTPcURLJavaScriptPython

DELETE /api/protocols/ethernet-ip/connections/devices/multi/by-ids?deviceIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content