v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Addons /

Get addon backup

Gets details about a given backup.

Required permission

Project > Addons > General > Read

Path parameters

    • projectId

      string required
      ID of the project

    • addonId

      string required
      ID of the addon

    • backupId

      string required
      ID of the backup

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        The identifier for the backup.

      • name

        string required
        The name of the backup.

      • status

        string required
        The current status of the backup.
        one of
        scheduled, in-progress, completed, aborting, aborted, failed, not-supported

      • createdAt

        string required
        The time the backup was initiated.

      • completedAt

        string
        The time the backup was completed.

      • config

        {object} required
        Data about the backup configuration.

        • source

          {object}
          Data about the source of the backup.

          • type

            string
            The type of backup.
            one of
            fileUpload, liveInstance, snapshot, externalDump, sameAddon

        • size

          string required
          The size of the backup, in bytes

        • addonVersion

          string
          The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored.

      • lastRestore

        {object}
        Details about the most recent restore of this backup.

        • restoreTimestamp

          string required
          The time the backup was initiated.

        • status

          string required
          The current status of the restore.
          one of
          scheduled, in-progress, completed, aborting, aborted, failed, not-supported

        • completedAt

          string
          The time the restore was completed.
API
CLI
JS Client

GET /v1/projects/{projectId}/addons/{addonId}/backups/{backupId}

Example response

200 OK

Details about the given backup.

JSON

{
  "data": {
    "id": "example-backup",
    "name": "Example Backup",
    "status": "completed",
    "createdAt": "2021-01-20T11:19:53.175Z",
    "completedAt": "2021-01-20T11:19:54.494Z",
    "config": {
      "source": {
        "type": "snapshot"
      },
      "size": "1234",
      "addonVersion": "4.4.8"
    },
    "lastRestore": {
      "restoreTimestamp": "2021-01-20T11:19:54.494Z",
      "status": "completed",
      "completedAt": "2021-01-20T11:19:54.494Z"
    }
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com