List backup destinations

GET

/backup-destinations

curl --request GET \
  --url https://example.com/api/v1/backup-destinations \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Every signed-in user may list destinations (to choose one); secrets are never returned.

Authorizations

• sessionCookie
• bearerToken

Responses

200

Destinations by name.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

string format: uuid

name

required

string

kind

required

string

Allowed values: NODE_DIRECTORY S3

subdirectory

For NODE_DIRECTORY, the directory below each Agent’s -backup-dir.

string

s3

object

endpoint

required

string

bucket

required

string

region

required

string

prefix

required

string

accessKeyId

required

string

customCa

required

Whether extra CA certificates are trusted for the endpoint.

boolean

recipient

required

The age public key backups are encrypted to.

string

createdAt

required

string format: date-time

Example

{
  "items": [
    {
      "kind": "NODE_DIRECTORY"
    }
  ]
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}