Alert sources

List alert sources

Returns the team's alert sources, by name.

get/alert-sources

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Query parameters

filter[type]'webhook' | 'email' | 'alertmanager' | 'grafana' | 'sentry'

The external tool behind an alert source; decides how its requests are read.

webhook <br/> Spectate's own JSON format, for scripts, CI and anything that can call a URL.
email <br/> Emails to the source's own address (subject becomes the alert).
alertmanager <br/> Prometheus Alertmanager webhook_configs.
grafana <br/> Grafana Alerting webhook contact point (Alertmanager format plus Grafana links).
sentry <br/> Sentry internal integration webhooks (SaaS and self-hosted), or the legacy WebHooks plugin.

Only sources of this tool.

pageinteger

Page number, from 1.

per_pageinteger

Sources per page, 1 to 100.

Response

Paginated set of AlertSource

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "Production Alertmanager",
      "auto_resolve_minutes": 60,
      "settings": {
        "signature_header": "X-Grafana-Alerting-Signature"
      },
      "escalation_paths": [
        {
          "name": "On-call engineers"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.