Linode Instances

List Backups

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

Returns information about this Linode's available backups.

Authorizations

Personal Access Token
OAuth: ( linodes:read_only)

Path Parameters

linodeId
Required
integer

The ID of the Linode the backups belong to.

Request Samples

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

Response Samples

{
  "automatic": [],
  "snapshot": [
    {
      "in_progress": "",
      "current": ""
    }
  ]
}

Responses

200: A collection of the specified Linode's available backups.

automatic
array of objects
snapshot
object
in_progress
object

An object representing a Backup or snapshot for a Linode with Backup service enabled.

id
integer

The unique ID of this Backup.

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.

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

The current state of a specific Backup.

created
string

The date the Backup was taken.

updated
string

The date the Backup was most recently updated.

finished
string

The date the Backup completed.

label
Nullable
string

A label for Backups that are of type snapshot.

configs
array

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

disks
array

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

current
object

An object representing a Backup or snapshot for a Linode with Backup service enabled.

id
integer

The unique ID of this Backup.

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.

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

The current state of a specific Backup.

created
string

The date the Backup was taken.

updated
string

The date the Backup was most recently updated.

finished
string

The date the Backup completed.

label
Nullable
string

A label for Backups that are of type snapshot.

configs
array

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

disks
array

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

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.

Create Snapshot

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

Creates a snapshot Backup of a Linode. If you already have a snapshot of this Linode, this is a destructive action. The previous snapshot will be deleted.

Authorizations

Personal Access Token
OAuth: ( linodes:read_write)

Path Parameters

linodeId
Required
integer

The ID of the Linode the backups belong to.

Request Body Schema

label
Required
string [1 .. 255] characters

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
      "label": "MyNewSnapshot"
    }' \
    https://api.linode.com/v4/linode/instances/123/backups

Response Samples

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

Responses

200: Snapshot was successfully taken.

id
integer

The unique ID of this Backup.

label
Nullable
string

A label for Backups that are of type snapshot.

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

The current state of a specific Backup.

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.

created
string <date-time>

The date the Backup was taken.

updated
string <date-time>

The date the Backup was most recently updated.

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.