Team / Backup Destinations /

Get backup destination

View a backup destination, including secrets.

Required permission

Account > Platform > BackupDestinations > Read

Path parameters

Response body

name
string required
The name of the backup destination.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
type
string required
Type of the backup destination.
one of
s3
usage
string required
The backup workload that can use this destination.
one of
globalBackups, containerSnapshots
prefix
string required
A prefix path to add to the bucket objects if not writing to /
pattern
^([a-zA-Z0-9-_]+)\/$
credentials
{object} required
Credentials used for the backup destination.

authMode
string
Whether the destination authenticates with static AWS credentials or a workload identity.
one of
staticCreds, workloadIdentity
workloadIdentityId
(multiple options: oneOf)

string

string

string

bucketName
string required
region
string required
endpoint
string required
S3 destination including region, fe s3.us-west-2.amazonaws.com
enableObjectLock
boolean
Enable S3 Object Lock (WORM) for this destination. Immutable after creation. Bucket must have Object Lock enabled.
objectLockRetentionDays
integer
Retention period in days for object-locked blobs. Required if enableObjectLock is true. Immutable after creation.
min
1
max
365

API

CLI

JS Client

GET /v1/backup-destinations/{backupDestinationId}

GET /v1/teams/{teamId}/backup-destinations/{backupDestinationId}

Example response

200 OK

Details of the backup destination.

JSON

{
  "data": {
    "name": "Example Backup Destination",
    "id": "example-backup-destination"
  }
}