Skip to main content
POST
Posts an external alert against a client for the service provider.

Authorizations

X-API-Key
string
header
required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Body

Alert details.

Request body for posting an external alert against a client.

Name
string
required

Alert name / title. Required.

Minimum string length: 1
Example:

"Disk usage above 90%"

ClientId
integer<int64>
required

Identifier of the client the alert relates to. Required.

Resource
string
required

Resource the alert is raised for (e.g. host name, service).

Minimum string length: 1
Example:

"SRV-DB-01"

Severity
enum<integer>

How severe an alert is: 1 Critical, 2 Error, 3 Warning, 4 Information.

Available options:
1,
2,
3,
4
Description
string

Free-text alert description.

AgentAssetId
string<uuid> | null

The agent asset the alert is about - an id from GET /v1/assets/agents. Optional; at most one of AgentAssetId, CustomAssetId and UptimeId may be sent. It must belong to ClientId. Resource stays free text.

CustomAssetId
string<uuid> | null

The custom asset the alert is about - an id from GET /v1/assets/custom. Optional; see AgentAssetId.

UptimeId
string<uuid> | null

The uptime the alert is about - an id from GET /v1/uptime. Optional; see AgentAssetId.

Response

OK

StatusCode
enum<integer>
Available options:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
boolean
DataContext
object | null
Example:

null

Notifications
object[]