Reseller API
The Reseller API lets your own systems create and manage storage for your customers. It covers datastores, S3 buckets and the features around them, and every call works on the resources in your own account. Only accounts with reseller access can use it.
Create a token
Open Settings > Security in the dashboard and find Reseller API Tokens. Click Create Reseller Token and give the token a name. The dashboard shows the token only once, so copy it to a safe place right away. Send it with every request as a Bearer token in the Authorization header.
Make your first calls
All reseller endpoints live under https://api.remote-backups.com/reseller. The examples below list your datastores and create a new one.
curl -H "Authorization: Bearer $TOKEN" \
"https://api.remote-backups.com/reseller/datastore?exclude_metrics=true"
The reply lists every datastore in your account with its server connection details. Leave out exclude_metrics to also get live usage and backup counts. That makes the call slower.
curl -X POST -H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"friendly": "customer-a", "size": 500}' \
https://api.remote-backups.com/reseller/datastore
friendly is the display name and size is in GB. Add region to pick a location, or leave it out and we choose a server with enough free space. The call returns once the datastore is ready, and the reply already contains its credentials, so you can hand them to your customer right away.
What the API covers
The API reference describes every endpoint with its fields and error codes. This table gives you the overview.
| Area | What you can do |
|---|---|
| Datastores | Create, list, rename, resize and delete datastores; set autoscaling, speed tier and prune settings; read usage graphs; rotate credentials; add SSH keys |
| Namespaces and ACLs | Create and delete namespaces; allow source IP ranges per datastore |
| Immutable backups | Turn the immutable copy of a datastore on, change it or turn it off; request early deletion of the backups of one guest |
| Replication | Preview and set up copies of a datastore in other regions |
| Remotes and sync jobs | Register other PBS servers as remotes and sync their backups into your datastores |
| S3 buckets | Calculate the price, create, resize and delete buckets; change settings; rotate keys; browse objects and create download links |
| VPN | Create and remove WireGuard connections |
| Tasks | Read the PBS task list and task logs |
| Custom domains | List your custom domains and their status |
Custom domains are added and verified in the dashboard. The API only reads them. See Custom domains.