Skip to main content

Alerts

GET/api/v1/nodes/{node_id}/monitoring/alerts/

Path parameters

  • node_idPathstringrequired

    Path parameter node_id.

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

    Location filter for alerts

    • must be a non-empty string
    • may contain alphanumeric characters, spaces, and hyphens
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the response

example200
  • must be an integer
  • must be a valid HTTP status code
dataobject
errorsstring

Human-readable error message returned by the API

example
  • may be empty string when no error
  • must be a UTF-8 encoded string
messagestring

Human-readable status message for the alerts response

exampleEmails retrieved successfully
  • Must be a non-empty string
  • Should be concise (e.g., under 200 characters)