Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Update alert message

This endpoint is used to update the message of an existing alert. This endpoint plays a crucial role in ensuring that alert messages remain accurate and up-to-date, aiding in the effective management and resolution of incidents.

patch/api/{cloudId}/v1/alerts/{id}/message

Path parameters

idstring required

Identifier of the alert.

Request body

messagestring required

Brief summary of the alert that provides enough information to understand the nature of the issue at a glance.

Example request

{
  "message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes."
}

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"
}