This page will help you get started with BackupSheep API

The BackupSheep API provides the capability to handle backups within the BackupSheep platform.

You can locate the methods for the BackupSheep API on this page. This API enables you to automate your backups by integrating your servers with BackupSheep, verifying server connectivity, establishing file and database backups, and executing them.

API Keys

You can find your API keys on the users page under settings


API authentication is passed in the header. In the following example replace API_KEY with your key.

curl --request GET \
     --url '' \
     --header 'Authorization: Token API_KEY' \
     --header 'accept: application/json'

API Endpoint

The primary endpoint of BackupSheep API is

Some APIs are routed through endpoint so ensure that the request is carried out by the backup server.