Monitor API specification (1.9.2)

Download OpenAPI specification:Download

The monitor service implements all monitor functions for GroupAlarm

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security scheme type: API Key
header parameter name: Personal-Access-Token

monitor

ListMonitors

Returns all monitors for the given organization

query Parameters
organization
required
integer

ID of the organization of which the monitors should be listed

Responses

200

array of all monitors for the given organization

400

organization ID is missing or in wrong format

500

Unexpected database error

get /
https://app.groupalarm.com/api/v1/monitor/

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

EditMonitor

Updates a given monitor with new values

Request Body schema: application/json
configuration
object (PropertyMap)

PropertyMap is used as container for additional data in alarms or messages it can be stored and retrieved easily in our Postgres database

id
integer <int64>

The internal ID of the Monitor

name
string

The name of the Monitor that is displayed in the UI

organizationID
integer <int64>

The organization the Monitor is part of

Responses

200

the edited monitor with new values

400

monitor in wrong format or missing required field

500

Unexpected database error

put /
https://app.groupalarm.com/api/v1/monitor/

Request samples

application/json
Copy
Expand all Collapse all
{
  • "configuration":
    {
    },
  • "id": 0,
  • "name": "string",
  • "organizationID": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "configuration":
    {
    },
  • "id": 0,
  • "name": "string",
  • "organizationID": 0
}

CreateMonitor

Creates a new Monitor

Request Body schema: application/json
configuration
object (PropertyMap)

PropertyMap is used as container for additional data in alarms or messages it can be stored and retrieved easily in our Postgres database

id
integer <int64>

The internal ID of the Monitor

name
string

The name of the Monitor that is displayed in the UI

organizationID
integer <int64>

The organization the Monitor is part of

Responses

201

the created monitor with ID

400

monitor in wrong format or missing required field

500

Unexpected database error

post /
https://app.groupalarm.com/api/v1/monitor/

Request samples

application/json
Copy
Expand all Collapse all
{
  • "configuration":
    {
    },
  • "id": 0,
  • "name": "string",
  • "organizationID": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "configuration":
    {
    },
  • "id": 0,
  • "name": "string",
  • "organizationID": 0
}

GetMonitor

Returns the Monitor for the given Monitor-ID

path Parameters
monitor_id
required
integer

ID of the Monitor that should be fetched

Responses

200

monitor

400

monitor ID is missing or in wrong format

500

Unexpected database error

get /{monitor_id}
https://app.groupalarm.com/api/v1/monitor/{monitor_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "configuration":
    {
    },
  • "id": 0,
  • "name": "string",
  • "organizationID": 0
}

DeleteMonitor

Deletes the given monitor by ID

path Parameters
monitor_id
required
integer

The ID of the monitor that should be deleted

Responses

200

delete monitor

400

monitor id is missing or in wrong format

500

Unexpected database error

delete /{monitor_id}
https://app.groupalarm.com/api/v1/monitor/{monitor_id}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Eintrag erfolgreich gelöscht"
}

monitor-data

GetMonitorData

Returns all data for a given monitor

path Parameters
monitor_id
required
integer

The ID of the monitor

Responses

200

mobile configurations for passed user

400

owner ID is missing or in wrong format

500

Unexpected database error

get /{monitor_id}/data
https://app.groupalarm.com/api/v1/monitor/{monitor_id}/data

Response samples

application/json
Copy
Expand all Collapse all
{
  • "alarmData":
    {
    },
  • "metaData":
    {
    }
}

SetMonitorDataAlarming

Create or overwrites the monitor alarming data

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
awaitingResponses
integer
event
string
geo
object
message
string
negativeResponses
integer
positiveResponses
integer
units
Array of object

Responses

200

response message

400

required parameter missing or in wrong format

500

Unexpected database error

post /{monitor_id}/data/alarming
https://app.groupalarm.com/api/v1/monitor/{monitor_id}/data/alarming

Request samples

application/json
Copy
Expand all Collapse all
{
  • "awaitingResponses": 20,
  • "event": "Brand in der Goethestraße",
  • "geo":
    {
    },
  • "message": "Großbrand in der Goethestraße 5",
  • "negativeResponses": 1,
  • "positiveResponses": 2,
  • "units":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Eintrag erfolgreich gespeichert"
}

UpdateMonitorDataAlarming

Patches one or more field from the monitor alarming data

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
awaitingResponses
integer
event
string
geo
object
message
string
negativeResponses
integer
positiveResponses
integer
units
Array of object

Responses

200

response message

400

required parameter missing or in wrong format

500

Unexpected database error

patch /{monitor_id}/data/alarming
https://app.groupalarm.com/api/v1/monitor/{monitor_id}/data/alarming

Request samples

application/json
Copy
Expand all Collapse all
{
  • "awaitingResponses": 5,
  • "positiveResponses": 10
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Eintrag erfolgreich gespeichert"
}

SetMonitorDataMeta

Create or overwrites the monitor meta data

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
latestAlarms
Array of string
pagers
object

Responses

200

response message

400

required parameter missing or in wrong format

500

Unexpected database error

post /{monitor_id}/data/meta
https://app.groupalarm.com/api/v1/monitor/{monitor_id}/data/meta

Request samples

application/json
Copy
Expand all Collapse all
{
  • "latestAlarms":
    [
    ],
  • "pagers":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Eintrag erfolgreich gespeichert"
}

UpdateMonitorDataMeta

Patches one or more field from the monitor meta data

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
latestAlarms
Array of string
pagers
object

Responses

200

response message

400

required parameter missing or in wrong format

500

Unexpected database error

patch /{monitor_id}/data/meta
https://app.groupalarm.com/api/v1/monitor/{monitor_id}/data/meta

Request samples

application/json
Copy
Expand all Collapse all
{
  • "pagers":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Eintrag erfolgreich gespeichert"
}