Alarm Group Controller | Version 2022

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

groupIdstringRequired

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/{groupId}

GET /api/alarms/groups/{groupId} 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",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}

put

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

groupIdstringRequired

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

priorityinteger · int32 · min: 1 · max: 255Required

onAckColorstring · max: 7Optional

namestring · max: 100Required

scanTimeInMillisinteger · int32 · min: 100Required

printerPortinteger · int32Optional

offAckColorstring · max: 7Optional

offNoAckColorstring · max: 7Optional

onNoAckColorstring · max: 7Optional

onScriptIdstringOptional

printWhenOnbooleanOptional

printWhenOffbooleanOptional

ackScriptIdstringOptional

hiddenOnMonitorbooleanOptional

printWhenAckbooleanOptional

printerIpstring · max: 15Optional

projectIdstringOptional

dscstring · max: 255Optional

offScriptIdstringOptional

ownerstringOptional

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/alarms/groups/{groupId}

PUT /api/alarms/groups/{groupId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}

No content

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

Path parameters

groupIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/alarms/groups/{groupId}

DELETE /api/alarms/groups/{groupId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups

GET /api/alarms/groups 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",
    "priority": 1,
    "onAckColor": "text",
    "name": "text",
    "scanTimeInMillis": 1,
    "printerPort": 1,
    "offAckColor": "text",
    "offNoAckColor": "text",
    "onNoAckColor": "text",
    "onScriptId": "text",
    "printWhenOn": true,
    "printWhenOff": true,
    "ackScriptId": "text",
    "hiddenOnMonitor": true,
    "printWhenAck": true,
    "printerIp": "text",
    "projectId": "text",
    "dsc": "text",
    "offScriptId": "text",
    "owner": "text"
  }
]

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

Body

creationDatestring · date-timeRead-onlyOptional

lastModifiedBystringRead-onlyOptional

createdBystringRead-onlyOptional

lastModifiedDatestring · date-timeRead-onlyOptional

idstringOptional

priorityinteger · int32 · min: 1 · max: 255Required

onAckColorstring · max: 7Optional

namestring · max: 100Required

scanTimeInMillisinteger · int32 · min: 100Required

printerPortinteger · int32Optional

offAckColorstring · max: 7Optional

offNoAckColorstring · max: 7Optional

onNoAckColorstring · max: 7Optional

onScriptIdstringOptional

printWhenOnbooleanOptional

printWhenOffbooleanOptional

ackScriptIdstringOptional

hiddenOnMonitorbooleanOptional

printWhenAckbooleanOptional

printerIpstring · max: 15Optional

projectIdstringOptional

dscstring · max: 255Optional

offScriptIdstringOptional

ownerstringOptional

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups

POST /api/alarms/groups HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}

{
  "creationDate": "2025-11-22T23:40:38.543Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-11-22T23:40:38.543Z",
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}

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

Path parameters

groupIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/{groupId}/deactivate

POST /api/alarms/groups/{groupId}/deactivate HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

Path parameters

groupIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/{groupId}/activate

POST /api/alarms/groups/{groupId}/activate HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/import

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

{
  "file": "binary"
}

{}

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

projectIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/deactivate/by-project

POST /api/alarms/groups/deactivate/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

projectIdstringRequired

namestringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/deactivate/by-project-and-name

POST /api/alarms/groups/deactivate/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

projectIdstringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/activate/by-project

POST /api/alarms/groups/activate/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

projectIdstringRequired

namestringRequired

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/groups/activate/by-project-and-name

POST /api/alarms/groups/activate/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content

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

alarmGroupIdstringRequired

Responses

200

OK

*/*

Responsestring · enumPossible values:

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/{alarmGroupId}/status

GET /api/alarms/groups/{alarmGroupId}/status HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

Active

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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/status/by-project

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

{
  "ANY_ADDITIONAL_PROPERTY": "Active"
}

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

namestringRequired

Responses

200

OK

*/*

Responsestring · enumPossible values:

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/status/by-project-and-name

GET /api/alarms/groups/status/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

Active

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/export

GET /api/alarms/groups/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

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/groups/by-project

GET /api/alarms/groups/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",
    "priority": 1,
    "onAckColor": "text",
    "name": "text",
    "scanTimeInMillis": 1,
    "printerPort": 1,
    "offAckColor": "text",
    "offNoAckColor": "text",
    "onNoAckColor": "text",
    "onScriptId": "text",
    "printWhenOn": true,
    "printWhenOff": true,
    "ackScriptId": "text",
    "hiddenOnMonitor": true,
    "printWhenAck": true,
    "printerIp": "text",
    "projectId": "text",
    "dsc": "text",
    "offScriptId": "text",
    "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

groupIdsstring[]Required

Responses

204

No Content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

delete

/api/alarms/groups/multi/by-ids

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

No content