Welcome, this API allows you to interact programmatically with the Phare platform, enabling seamless integration and automation of almost everything that can be done in your control panel.

Create an API key

Only team members with the Owner or Admin role can create an API key in your organization.

To access the Phare API, you will need to create an API key with the right accesses, this can be done on your control panel.

While creating an API key, you will be able to choose an access scope (Read / Write) for each Phare product as well as access to the resources of the Phare platform. You can find the list of available endpoints in the left navigation of this documentation.

You can create as many keys as necessary to fit your use case.

Authentication

The Phare API uses Bearer Token Authentication to secure access to its endpoints. To authenticate your requests, include the API key in the Authorization header of your HTTP requests. The format for this header is as follows:

Request Authorization header
Authorization: Bearer YOUR_API_KEY

Here’s an example of a cURL command to list the monitors in your project using your API key:

curl \
-X GET "https://api.phare.io/uptime/monitors" \
-H "Authorization: Bearer YOUR_API_KEY"
Keep your API key confidential at all time. Do not share it publicly or expose it in client-side code.

If you suspect that your API key has been compromised, revoke it immediately through your control panel and generate a new one.

Rate limiting

Access to the API is currently rate limited to 100 calls per minute across your organization. This means that all the API keys in your organization will share the same rate limiting.


If you are missing an API endpoint or need a custom rate limit for your organization, feel free to contact us, we’ll be happy to find a solution for your use case.