Percona Everest API

Percona Everest provides a set of APIs that enable you to access its features programmatically. These APIs provide a convenient and efficient way for developers to interact with the various functionalities of Percona Everest.

Using the API

The API is accessible on the same host and port as the Percona Everest Web UI. You can find detailed information about connecting to the Percona Everest Web UI in the installation guides. For instance, if you are connecting to your Percona Everest instance using port forwarding:

kubectl port-forward svc/everest 8080:8080 -n everest-system

You can then connect to the API via the http://127.0.0.1:8080 host.

Authentication

Currently, the API only supports authentication via a JWT token.

You can obtain this JWT token from the Web UI after logging in. For the built-in Everest users you can also obtain this JWT token by calling the following endpoint:

curl --location -s '<EVEREST_HOST>/v1/session' --header 'Content-Type: application/json' --data '{"username": "<YOUR_USERNAME>","password": "<YOUR_PASSWORD>"}' | jq -r .token

Readme.io API documentation

While you can achieve many tasks using either the Percona Everest user interface or everestctl, leveraging the API allows for easier integration into your technology infrastructure.

Check out our API endpoints for Percona Everest, where you can perform a wide range of functions.

To access the API documentation, click Percona Everest API.