HYhyperdxio
Alerts

List Alerts

Changed on

Retrieves alerts for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When more records exist than are returned, meta.total exceeds data.length; clients with large collections must page with limit/offset to retrieve them all. Optional filters narrow the result set, and meta.total counts only the matching alerts.

get/api/v2/alerts

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/alerts
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of alerts to return.

offsetinteger

Number of alerts to skip before returning results.

tagstring[]

Only return alerts that have any of the given tags. Repeat the parameter to pass several tags. Matches the tags stored on the alert, not tags inherited from the linked dashboard or saved search.

searchstring

Only return alerts whose display name contains this text (case-insensitive). Matches the display name stored on the alert, not a name derived from the linked dashboard or saved search.

sourceAlertSource[]

Only return alerts of any of the given sources. Repeat the parameter to pass several sources.

stateAlertState[]

Only return alerts in any of the given states. Repeat the parameter to pass several states.

Response

Successfully retrieved alerts

Changes

  • a7cac1e12b89Revision changes
    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter source

    • info

      added the new optional query request parameter state

    • info

      added the new optional query request parameter tag

    • info

      added the non-success response with the status

  • b755030b0f33Revision changes
    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • breaking

      added to the ////////////// response property oneOf list for the response status

    • info

      added promql discriminator mapping keys to the ////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the ////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the ////////////// response property for the response status

    • info

      added promql discriminator mapping keys to the ////////////// response property for the response status