Skip to main content
Version: Next

Server API Specification Reference

The server API provides HTTP methods for checking the status of the server, listing the available buckets, and retrieving the permissions for the current API token.

Get Statistical Information about Instance​

You can use this method to get stats of the storage, check its version and license.

If authentication is enabled, the method needs a valid API token.

get
/api/v1/info
Get statistical information about the storage

Get a Bucket List with Metadata​

You can use this method to browse the buckets of the storage.

If authentication is enabled, the method needs a valid API token.

get
/api/v1/list
Get a list of the buckets with their stats

Check if the Storage Engine is Alive​

You can use GET and HEAD methods for health checks in Docker or Kubernetes environment. The method has anonymous access.

get
/api/v1/alive
Check if the storage engine is working
head
/api/v1/alive
Check if the storage engine is working

Check if the Storage Engine is Active​

If the RS_LOCK_FILE_ENABLED environment variable is set to true, the storage engine starts using a lock file mechanism to prevent multiple instances from accessing the same data directory simultaneously. In this case, you can use GET and HEAD methods to check if the storage engine is active and has acquired the lock on the data directory.

get
/api/v1/ready
Check if the storage engine is working
head
/api/v1/ready
Check if the storage engine is working