Get a backup

get https://api.linode.com/{apiVersion}/linode/instances/{linodeId}/backups/{backupId}

Returns information about a Backup.

linode-cli linodes backup-view 123 123456


Learn more...

linodes:read_only


Learn more...

Responses

Response body

object

available

boolean

Read-only Whether this Backup is available for restoration.

Backups undergoing maintenance are not available for restoration.

configs

array of strings

Read-only A list of the labels of the Configuration profiles that are part of the Backup.

configs

created

date-time

Read-only The date the Backup was taken.

disks

array of objects

Read-only A list of the disks that are part of the Backup.

disks

object

filesystem

string

The disk's format or file system. A value of raw indicates no file system, just a raw binary stream. A value of swap indicates a Linux swap area. The values ext3 or ext4 represent these Linux journaling file systems. The value ext2 is the deprecated ext2 Linux file system. Finally, initrd indicates the disk is formatted as an uncompressed initial RAM disk.

📘
The ext2 file system doesn't properly support timestamps and will be removed from Linux support in the near future. Also, initrd is a legacy format that no longer applies to most use cases. As a best practice, use the other supported formats or file systems instead.

raw swap ext2 ext3 ext4 initrd

label

string

size

integer

finished

date-time

Read-only The date the Backup completed.

integer

Read-only The unique ID of this Backup.

label

string | null

A label for Backups that are of type snapshot.

status

string

Read-only The current state of a specific Backup.

paused pending running needsPostProcessing successful failed userAborted

type

string

Read-only This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.

auto snapshot

updated

date-time

Read-only The date the Backup was most recently updated.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/linode/instances/linodeId/backups/backupId \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "available": true,
3
  "configs": [
4
    "My Debian 9 Config"
5
  ],
6
  "created": "2018-01-15T00:01:01",
7
  "disks": [
8
    {
9
      "filesystem": "ext4",
10
      "label": "My Debian 9 Disk",
11
      "size": 9001
12
    }
13
  ],
14
  "finished": "2018-01-15T00:01:01",
15
  "id": 123456,
16
  "label": "Webserver-Backup-2018",
17
  "status": "successful",
18
  "type": "snapshot",
19
  "updated": "2018-01-15T00:01:01"
20
}

200A single Backup.

📘

defaultSee Errors for the range of possible error response codes.