Alerts

Alerts triggered by Alert Rules.

Endpoints

Get alerts

Endpoint
get /alerts
Description

Get a list of alerts that match the specified criteria.

Query Parameters

  • projectId

    integer

    required

    Return alerts of the specified project. Either projectId or homeId should be specified.

  • homeId

    integer

    required

    Return alerts of the specified home. Either projectId or homeId should be specified.

  • alertRuleId

    string

    Return alerts of the specified alert rule.

  • entityId

    string

    Return alerts of the specified entity.

  • state

    integer

    Return alerts with the specified state.

  • severity

    integer

    Return alerts with the specified severity.

  • skip

    integer

    Number of alerts to skip over.

  • limit

    integer

    Maximum number of alerts to return.

    Default value is 25

    Minimum value is 1

Request Headers What's this?

  • Authorization

    required

    Must contain a project API key.

Response
  • 200Successful retrieval of alerts.
  • 401Authorization is required to access this resource.
  • 403Request failed because of denied permission.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Response Body Sample

Can not resolve ../schemas/examples/alerts_array_example.json