latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Backups
Backup Destination

Return a backup destination's settings

Use this function to obtain a backup destination's settings.

get/backup_destination_get

Query parameters

idstring required
Example:0W1ei2rd3A4lI5sT6he7Be8st

The backup destination's ID.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "disable_reason": "Could not list files in destination: example",
    "id": "sNnLb1req9oJN9lUJFhA99kY",
    "name": "destination_name",
    "type": "Local",
    "aws_access_key_id": "s123456789",
    "bucket": "ChockFullOfNuts",
    "folder": "subfolder",
    "timeout": 300
  },
  "metadata": {
    "command": "backup_destination_get",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}