Team / Backup Destinations /

Add backup destination

Adds a new backup destination to this account.

Required permission

Account > Platform > BackupDestinations > Create

Request body

{object}

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

accessKey
(multiple options: oneOf)

string

secretKey
(multiple options: oneOf)

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

Response body

{object}
Response object.

data
{object} required
Result data.

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

accessKey
(multiple options: oneOf)

string

secretKey
(multiple options: oneOf)

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

id
string required
Identifier for the backup destination
createdAt
string
time of creation
updatedAt
string
time of update

API

CLI

JS Client

POST /v1/backup-destinations

POST /v1/teams/{teamId}/backup-destinations

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Backup Destination","type":"s3","usage":"globalBackups","prefix":"example/","credentials":{"bucketName":"string","region":"string","endpoint":"string"}}' \
  https://api.northflank.com/v1/backup-destinations

Example response

200 OK

Data about the newly created backup destination.

JSON

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