# Get backup destination

View a backup destination, including secrets.

Required permission: Account > Platform > BackupDestinations > Read

**Path parameters:**

{object}
- `backupDestinationId`: (string) (required) ID of the backup destination

**Response body:**

{object}
- `data`: {object}
  - `name`: (string) (required) The name of the backup destination. (pattern: ^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$) (min length: 3) (max length: 100)
  - `description`: (string) (pattern: ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$) (max length: 200)
  - `type`: (string) (required) Type of the backup destination. (enum: s3)
  - `usage`: (string) (required) The backup workload that can use this destination. (enum: 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}
    - `authMode`: (string) Whether the destination authenticates with static AWS credentials or a workload identity. (enum: staticCreds, workloadIdentity)
    - `workloadIdentityId`: (multiple options) (string) ID of the workload identity used to authenticate with the S3 destination. | (string) ID of the workload identity used to authenticate with the S3 destination.
    - `accessKey`: (multiple options) (string) Access key used to authenticate with the S3 destination.
    - `secretKey`: (multiple options) (string) Secret key used to authenticate with the S3 destination.
    - `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.
  - `id`: (string) (required) Identifier for the backup destination
  - `createdAt`: (string) time of creation (format: date-time)
  - `updatedAt`: (string) time of update (format: date-time)

## API reference

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"
  }
}
```

## CLI reference

$ northflank get backup-destination

Options:

- `--backupDestinationId <backupDestinationId>`: ID of the backup destination

- `--verbose `: Verbose output

- `--quiet `: No console output

- `-o --output <format>`: Output formatting 

### Example Response

 Details of the backup destination.

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

## JavaScript client reference

### Example request



```javascript
await apiClient.get.backupDestination({
  parameters: {
    "backupDestinationId": "example-destination"
  }
});
```

### Example Response

 Details of the backup destination.

```json
{
  "data": {
    "name": "Example Backup Destination",
    "id": "example-backup-destination"
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

Previous: [Add backup destination](/docs/v1/api/team/backup-destinations/add-backup-destination)

Next: [Patch backup destination](/docs/v1/api/team/backup-destinations/patch-backup-destination)