Create backup

Creates a new backup

POST/api/client/servers/{server}/backups

Authorization

ClientToken

AuthorizationBearer <token>

Client API key (generated at /account/api)

In: header

Path Parameters

server*string

Server identifier (short 8-character ID)

Request Body

application/json

name?|

Display name; generated from the current timestamp when omitted

is_locked?boolean

Prevents the backup from being deleted until unlocked

ignored?string

Newline-separated list of files and folders to exclude

Response Body

`application/json`

curl -X POST "https://pterodactyl.file.properties/api/client/servers/1a7ce997/backups" \  -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{  "name": "Before 1.20 update",  "is_locked": false,  "ignored": "cache\nlogs/*.log"}'

{
  "object": "backup",
  "attributes": {
    "uuid": "63087048-eada-419c-ad72-803c1c949cac",
    "is_successful": false,
    "is_locked": false,
    "name": "Backup at 2020-07-19 16:21:34",
    "ignored_files": [],
    "checksum": null,
    "bytes": 0,
    "created_at": "2020-07-19T16:21:34+01:00",
    "completed_at": null
  }
}