Skip to main content

Pause or Resume a Cluster Alert

Pauses or resumes an existing alert. Send action_type: "pause_alert" to stop the alert from firing, or action_type: "resume_alert" to re-enable it. The path takes the alert's alert_trigger_id.

PUT/api/v1/monitoring/single-service/stop_resume_alert/{alert_trigger_id}/

Path parameters

  • alert_trigger_idPathintegerrequired

    The alert trigger ID.

    • required
    • must be a valid alert trigger ID
    example12345

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Pause or resume an existing alert.

action_typestringrequired

The action to perform on the alert.

examplepause_alert
  • required
  • one of: pause_alert, resume_alert

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleAlert paused successfully