Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Alerts

Execute custom action

This endpoint is used to execute custom actions on an existing alert. Custom actions allow for more flexible and specific responses to alerts, including integrations with external systems or triggering complex workflows. This operation is a powerful tool for extending the capabilities of the alert management process beyond predefined actions.

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

Path parameters

idstring required

Request body

actionNamestring required

Action name that can be executed on the alert. This action is a custom to your organization and can be used to automate responses to specific alerts.

Example request

{
  "actionName": "RestartServer"
}

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