Alertmanager API
API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)
Endpoints 9
general
- GETgetStatus
/statusGet current status of an Alertmanager instance and its cluster
receiver
- GETgetReceivers
/receiversGet list of all receivers (name of notification integrations)
silence
- GETgetSilences
/silencesGet a list of silences - POSTpostSilences
/silencesPost a new silence or update an existing one - GETgetSilence
/silence/:silenceIDGet a silence by its ID - DELETEdeleteSilence
/silence/:silenceIDDelete a silence by its ID
alert
- GETgetAlerts
/alertsGet a list of alerts - POSTpostAlerts
/alertsCreate new Alerts
alertgroup
- GETgetAlertGroups
/alerts/groupsGet a list of alert groups
API details
- Authentication
- None declared in the description
- Operations
- 9 operations on 6 pathsGET 6POST 2DELETE 1
- Main resources
- silence 4alert 2alertgroup 1general 1receiver 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
0.0.1 - Links
- OpenAPI document
- Listed from
- Prometheus Alertmanager's published OpenAPI description (prometheus/alertmanager) (Apache-2.0)
How to test the Alertmanager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Alertmanager API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “getStatus” (GET /status), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Alertmanager API?
API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager) It is listed under Developer tools and has 9 endpoints.
Who publishes the Alertmanager API?
It is listed from Prometheus Alertmanager's public API description (an OpenAPI document), not published by Prometheus Alertmanager on Swastik Codes. Anyone who controls prometheus.io can claim the profile by adding a DNS TXT record.
How do I authenticate with the Alertmanager API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Alertmanager API have?
9 operations on 6 paths (6 GET, 2 POST, 1 DELETE). The largest groups are silence, alert, alertgroup, general.
Is forking the Alertmanager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.