Last modified November 7, 2024

getDestination

This function returns destination by id.
Parameters
Parameter name Type Description Possible values Example
_id String Required The ID of the destination.   _id=5f7bdce1ae2dfb28835cb4e2

This API Call returns a destination object.

To view the parameters returned, click on Destination Object.

Example Call JETAPI

jetbackup5api -F getDestination -D "_id={$DESTINATION_ID}"
success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
_id: 6503eec8ebbf07708d06f1d2
name: s3
owner: 6503d48bfc45b1addf0a9632
owner_name: root
type: S3
job_type: 1
count: 1
hidden:
readonly:
disabled:
disk_limit: 0
disk_usage:
threads: 10
update_date: 2023-09-15T15:50:36+00:00
dr: 1
reindex:
running:
options:
        path: /test
        access_key:
        secret_key: JB|HIDDEN|********************
        region: us-west-1
        bucket: bucket
        endpoint: s3.us-west-1.amazonaws.com
legacy:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getDestination&_id={$DESTINATION_ID}