v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Backup Destinations /

Get backup destination

View a backup destination, including secrets.

Required permission

Account > BackupDestinations > General > Read

Path parameters

    • backupDestinationId

      string required
      ID of the backup destination

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

      • 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.

        • accessKey

          string required

        • secretKey

          string required

        • bucketName

          string required

        • region

          string required

        • endpoint

          string required
          S3 destination including region, fe s3.us-west-2.amazonaws.com

      • id

        string required
        Identifier for the backup destination

      • createdAt

        string
        time of creation

      • updatedAt

        string
        time of update
API
CLI
JS Client

GET /v1/backup-destinations/{backupDestinationId}

Example response

200 OK

Details of the backup destination.

JSON

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

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com