Backups
List backups
Retrieves a list of backups
GET
/api/client/servers/{server}/backupsAuthorization
ClientToken AuthorizationBearer <token>
Client API key (generated at /account/api)
In: header
Path Parameters
server*string
Server identifier (short 8-character ID)
Query Parameters
page?integer
Page of results to return.
per_page?integer
Number of results per page (default 20, max 50).
Default
20Range
value <= 50Response Body
application/json
curl -X GET "https://pterodactyl.file.properties/api/client/servers/1a7ce997/backups?page=1&per_page=20" \ -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \ -H "Accept: application/json"{
"object": "list",
"data": [
{
"object": "backup",
"attributes": {
"uuid": "904df120-a66f-4375-a4ae-40eedbeae630",
"is_successful": true,
"is_locked": false,
"name": "Quick Backup",
"ignored_files": [],
"checksum": "sha1:7c20d6a269b441a9dfd044e3f8ad13d77c09c83af8832d29ad603084a9a63726",
"bytes": 114402862,
"created_at": "2020-06-13T05:21:01+01:00",
"completed_at": "2020-06-13T05:21:04+01:00"
}
},
{
"object": "backup",
"attributes": {
"uuid": "63087048-eada-419c-ad72-803c1c949cac",
"is_successful": true,
"is_locked": true,
"name": "Backup at 2020-07-19 16:21:34",
"ignored_files": [],
"checksum": "sha1:39bf93b9d8aee45316fa7ec8bbed0530904558851fa8e712452845c969873b16",
"bytes": 114567250,
"created_at": "2020-07-19T16:21:34+01:00",
"completed_at": "2020-07-19T16:21:35+01:00"
}
}
],
"meta": {
"backup_count": 2,
"pagination": {
"total": 2,
"count": 2,
"per_page": 20,
"current_page": 1,
"total_pages": 1,
"links": {}
}
}
}