Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Add responder to alert

This endpoint is used to assign a responder to an existing alert. The responder is the individual or team responsible for addressing the alert. This operation streamlines the alert management process by ensuring that alerts are directed to the correct parties for timely resolution.

post/api/{cloudId}/v1/alerts/{id}/responders

Path parameters

idstring required

Identifier of the alert.

Request body

idstring required

Identifier of the responder.

type'team' | 'user' | 'escalation' | 'schedule' required

Type of the responder.

Example request

{
  "id": "ac140ae4-757c-48a4-a079-041eb3bfe8d7"
}

Response

Returned if the request is successful.

resultstring

Indicates the outcome of the request.

requestIdstring

Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.

tookinteger

Example response

{
  "result": "Request will be processed",
  "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777"
}