Return a backup destination's settings

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

SecurityBasicAuth

Request

query Parameters

required

string

The backup destination's ID.

Example: id=0W1ei2rd3A4lI5sT6he7Be8st

Responses

200

HTTP Request was successful.

Response Schema: application/json

	any (BackupDestinationGetResponse)
	object

get/backup_destination_get

Request samples

whmapi1 --output=jsonpretty \
  backup_destination_get \
  id='0W1ei2rd3A4lI5sT6he7Be8st'

Response samples

application/json

{"data": {"aws_access_key_id": "access-key-id",
"bucket": "s3-bucket-brigade",
"disabled": 0,
"folder": "",
"id": "Sr1ThYOnnBIXUupTcSBYQywk",
"name": "Amazon S3",
"timeout": 30,
"type": "AmazonS3",
"upload_system_backup": 0
},
"metadata": {"command": "backup_destination_get",
"reason": "OK",
"result": 1,
"version": 1
}
}