Alarming API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The alarming service is used to configure and manage alarms.

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

alarm

CreateAlarm

Creates an alarm for an event and calculate required user for a notification

Request Body schema: application/json
alarmResourceTemplateID
integer <int64>

Contains the ID of a resource template which will replace the values of this alarm with the configured values of the template

object (AlarmCreationResources contains an alarm's alarmed scenarios, units, labels and / or users.)

At least one of those arrays must contain data, otherwise the alarm can not be started.

alarmTemplateID
integer <int64>

Alarm message template ID given ID is used to replace alarm's message text while creating a new alarm either this or Message have to be set

creatorID
integer <int64>

id of the creator resource

creatorName
string

name of the creator resource

creatorType
string

type of the creator resource (user|api-token|tag)

object (EscalationModeConfiguration is used to configure all required parameters for an alarm in escalation-mode.)
eventExternalID
string

ExternalID of the event defined by the user

eventID
integer <int64>

id of an existing event

eventName
string

Name of an event; if event name is passed, a new event will be created with the passed name

message
string

Alarm message text either this or AlarmTemplateID have to be set

mode
string

Alarm mode (strict|best-effort|escalation)

optionalContent
any

optional content (e.g. coordinates)

organizationID
required
integer <int64>

ID of the organization to create the alarm in

scenarioID
integer <int64>

id of the alarmed scenario

DEPRECATED: this property is deprecated and will be removed soon, please use alarmResources instead

scheduledEndTime
any

Scheduled time for closing the Event

startTime
any

Start time for this alarm. Uses the current time if not set.

Responses

Request samples

Content type
application/json
{
  • "alarmResourceTemplateID": 0,
  • "alarmResources": {
    },
  • "alarmTemplateID": 0,
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "escalationModeConfiguration": {
    },
  • "eventExternalID": "string",
  • "eventID": 0,
  • "eventName": "string",
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "scenarioID": 0,
  • "scheduledEndTime": null,
  • "startTime": null
}

Response samples

Content type
application/json
{
  • "alarmResources": {
    },
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "endDate": null,
  • "escalationModeConfiguration": {
    },
  • "event": {
    },
  • "feedback": [
    ],
  • "feedbackPercentage": {
    },
  • "id": 1,
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "startDate": null,
  • "strength": {
    },
  • "success": true
}

PreviewAlarm

Returns a preview of a planned alarm using the given resources

Request Body schema: application/json
alarmResourceTemplateID
integer <int64>

Contains the ID of a resource template which will replace the values of this alarm with the configured values of the template

object (AlarmCreationResources contains an alarm's alarmed scenarios, units, labels and / or users.)

At least one of those arrays must contain data, otherwise the alarm can not be started.

alarmTemplateID
integer <int64>

Alarm message template ID given ID is used to replace alarm's message text while creating a new alarm either this or Message have to be set

creatorID
integer <int64>

id of the creator resource

creatorName
string

name of the creator resource

creatorType
string

type of the creator resource (user|api-token|tag)

object (EscalationModeConfiguration is used to configure all required parameters for an alarm in escalation-mode.)
eventExternalID
string

ExternalID of the event defined by the user

eventID
integer <int64>

id of an existing event

eventName
string

Name of an event; if event name is passed, a new event will be created with the passed name

message
string

Alarm message text either this or AlarmTemplateID have to be set

mode
string

Alarm mode (strict|best-effort|escalation)

optionalContent
any

optional content (e.g. coordinates)

organizationID
required
integer <int64>

ID of the organization to create the alarm in

scenarioID
integer <int64>

id of the alarmed scenario

DEPRECATED: this property is deprecated and will be removed soon, please use alarmResources instead

scheduledEndTime
any

Scheduled time for closing the Event

startTime
any

Start time for this alarm. Uses the current time if not set.

Responses

Request samples