View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Linode Instances

Backup View

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

Returns information about a Backup.

Path Parameters

linodeId
Required
integer

The ID of the Linode the Backup belongs to.

backupId
Required
integer

The ID of the Backup to look up.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/linode/instances/123/backups/123456

Response Samples

{
  "status": "successful",
  "created": "2018-01-15T00:01:01",
  "updated": "2018-01-15T00:01:01",
  "id": 1234,
  "label": "Webserver-Backup-2018",
  "type": "snapshot",
  "available": true,
  "finished": "2018-01-15T00:01:01",
  "configs": [],
  "disks": [
    {
      "size": 9001,
      "filesystem": "ext4",
      "label": "My Debian 9 Disk"
    }
  ]
}

Responses

200: A single Backup.

status
string
Enum: "paused""pending""running""needsPostProcessing""successful""failed""userAborted"

The current state of a specific Backup.

created
string <date-time>

The date the Backup was taken.

updated
string <date-time>

The date the Backup was most recently updated.

id
integer

The unique ID of this Backup.

label
Nullable
string

A label for Backups that are of type snapshot.

type
string
Enum: "auto""snapshot"

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

available
boolean

Whether this Backup is available for restoration.

Backups undergoing maintenance are not available for restoration.

finished
string <date-time>

The date the Backup completed.

configs
array of objects

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

disks
array of objects

A list of the disks that are part of the Backup.

size
integer
filesystem
string
Enum: "raw""swap""ext3""ext4""initrd"

The Disk filesystem can be one of:

  • raw - No filesystem, just a raw binary stream.
  • swap - Linux swap area.
  • ext3 - The ext3 journaling filesystem for Linux.
  • ext4 - The ext4 journaling filesystem for Linux.
  • initrd - initrd (uncompressed initrd, ext2, max 32 MB).
label
string

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.