Algolia Monitoring API
The metrics exposed by this API are based on results from external monitoring probes checking Algolia’s infrastructure. These metrics reflect the overall…
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
The metrics exposed by this API are based on results from external monitoring probes checking Algolia’s infrastructure.
These metrics reflect the overall infrastructure status and don’t represent the performance of the specific APPID used for authentication.
Base URLs
Base URL for the Monitoring API:
https://status.algolia.com
All requests must use HTTPS.
Availability and authentication
Access to the Infrastructure endpoints
is available as part of the Premium or Elevate plans.
To authenticate requests to the Infrastructure endpoints, add these headers:
x-algolia-application-id. Your Algolia application ID.x-algolia-api-key. Your Monitoring API key.
You can find your application ID and API key in the Algolia dashboard.
Other endpoints don't require authentication.
Response status and errors
The Monitoring API returns JSON responses.
Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.
Successful responses return 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses.
Error responses have a message property with more information.
Version
The current version of the Monitoring API is version 1, indicated by the /1/ in each endpoint's URL.
Endpoints 14
monitoring
- GETSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - PUTSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - POSTSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - DELETESend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - GETRetrieve status of all clusters
/1/statusRetrieves the status of all Algolia clusters and instances. - GETRetrieve cluster status
/1/status/:clustersRetrieves the status of selected clusters. - GETRetrieve all incidents
/1/incidentsRetrieves known incidents for all clusters. - GETRetrieve cluster incidents
/1/incidents/:clustersRetrieves known incidents for the selected clusters. - GETRetrieve servers
/1/inventory/serversRetrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: With authentication, the response lists the… - GETRetrieve search latency times
/1/latency/:clustersRetrieves the average latency for search requests for selected clusters. - GETRetrieve indexing monitoring latency
/1/indexing/:clustersRetrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned… - GETTest the reachability of clusters
/1/reachability/:clusters/probesTest whether clusters are reachable or not. - GETRetrieve metrics
/1/infrastructure/:metric/period/:periodRetrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the Premium or… - GETSwitch the API key used to authenticate requests
/setClientApiKey?apiKey=stringSwitch the API key used to authenticate requests.
API details
- Base URL
https://status.algolia.com- Authentication
- An API key in the X-Algolia-Application-Id header
An API key in the X-Algolia-API-Key header - Operations
- 14 operations on 11 pathsGET 11PUT 1POST 1DELETE 1
- Main resources
- monitoring 14
- Response formats
application/json- Description format
- OpenAPI 3.0.2, API version
1.0.0 - Links
- OpenAPI document
How to test the Algolia Monitoring 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 Algolia Monitoring API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-Algolia-Application-Id header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Send requests to the Algolia REST API” (GET /:path), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Algolia Monitoring API?
The metrics exposed by this API are based on results from external monitoring probes checking Algolia’s infrastructure. These metrics reflect the overall… It is listed under Developer tools and has 14 endpoints.
Who publishes the Algolia Monitoring API?
It is listed from Algolia's public API description (an OpenAPI document), not published by Algolia on Swastik Codes. Anyone who controls algolia.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Algolia Monitoring API?
Requests go to https://status.algolia.com. Endpoint paths are added to this base URL.
How do I authenticate with the Algolia Monitoring API?
It accepts 2 methods: an API key in the X-Algolia-Application-Id header; an API key in the X-Algolia-API-Key header.
How many endpoints does the Algolia Monitoring API have?
14 operations on 11 paths (11 GET, 1 PUT, 1 POST, 1 DELETE). The largest groups are monitoring.
Is forking the Algolia Monitoring API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.