> ## Documentation Index
> Fetch the complete documentation index at: https://docs.levelrail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Backup target fields

> Every field of a backup target with its type, requirement, visibility rule and CLI flag.

The dashboard form, the CLI flags and the API all read one field registry, served at `GET /api/v1/field-descriptors/backup-targets`. Secrets are write only: they are accepted on create and update and never returned.

| Field | Type | Required | Shown when | CLI flag | Description |
| - | - | - | - | - | - |
| `name` (name) | string | yes | always | `--name` | display name for the backup target |
| `provider` (provider) | select | yes | always | `--provider` | provider: aws, r2, custom, local, webdav or sftp |
| `bucket` (s3.bucket) | string | yes | `provider` is aws or r2 or custom | `--bucket` | bucket name |
| `region` (s3.region) | string | no | `provider` is aws or r2 or custom | `--region` | bucket region (required for custom) |
| `endpoint` (s3.endpoint) | string | no | `provider` is r2 or custom | `--endpoint` | S3-compatible endpoint URL (required for r2 and custom) |
| `access_key_id` (s3.access\_key\_id) | string | yes | `provider` is aws or r2 or custom | `--access-key-id` | access key id |
| `secret_access_key` (s3.secret\_access\_key) | secret, write only | yes | `provider` is aws or r2 or custom | `--secret-access-key` | secret access key, write only |
| `region` (custom.region) | string | yes | `provider` is custom | none | bucket region required by custom providers |
| `bucket` (local.path) | string | yes | `provider` is local | `--path` | directory under the control plane local backup root |
| `endpoint` (webdav.endpoint) | string | yes | `provider` is webdav | none | https URL of the WebDAV share |
| `bucket` (webdav.directory) | string | yes | `provider` is webdav | none | remote directory on the share |
| `access_key_id` (webdav.username) | string | yes | `provider` is webdav | none | WebDAV username |
| `secret_access_key` (webdav.password) | secret, write only | yes | `provider` is webdav | none | WebDAV password, write only |
| `ca_bundle` (webdav.ca\_bundle) | text, write only | no | `provider` is webdav | `--ca-bundle-file` | PEM file of extra CA certificates to trust, write only |
| `endpoint` (sftp.endpoint) | string | yes | `provider` is sftp | none | SFTP server as HOST or HOST:PORT |
| `bucket` (sftp.path) | string | yes | `provider` is sftp | none | remote directory, paths containing .. are refused |
| `access_key_id` (sftp.username) | string | yes | `provider` is sftp | none | SSH username |
| `auth` (sftp.auth) | select | yes | `provider` is sftp | none | sftp authentication method, password or key (form only, the CLI infers it) |
| `secret_access_key` (sftp.password) | secret, write only | yes | `provider` is sftp and `auth` is password | none | SSH password, write only |
| `private_key` (sftp.private\_key) | text, write only | yes | `provider` is sftp and `auth` is key | `--private-key-file` | SSH private key file used instead of a password, write only |
| `private_key_passphrase` (sftp.private\_key\_passphrase) | secret, write only | no | `provider` is sftp and `auth` is key | `--private-key-passphrase` | passphrase of an encrypted private key, write only |
| `host_key` (sftp.host\_key) | string | yes | `provider` is sftp | `--host-key` | pinned SSH host key as printed by scan-host-key |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.