Linode Instances
Backups List
https://api.linode.com/v4/linode/instances/{linodeId}/backupsReturns information about this Linode's available backups.
Path Parameters
The ID of the Linode the backups belong to.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/linode/instances/123/backups
Response Samples
- 200
- default
{
"automatic": [
{
"id": 123456,
"type": "automatic",
"status": "successful",
"available": true,
"created": "2018-01-15T00:01:01",
"updated": "2018-01-15T00:01:01",
"finished": "2018-01-15T00:01:01",
"label": "Webserver-Backup-2018",
"configs": [],
"disks": []
}
],
"snapshot": {
"in_progress": {
"id": 123456,
"type": "snapshot",
"status": "successful",
"available": true,
"created": "2018-01-15T00:01:01",
"updated": "2018-01-15T00:01:01",
"finished": "2018-01-15T00:01:01",
"label": "Webserver-Backup-2018",
"configs": [],
"disks": []
},
"current": {
"id": 123456,
"type": "snapshot",
"status": "successful",
"available": true,
"created": "2018-01-15T00:01:01",
"updated": "2018-01-15T00:01:01",
"finished": "2018-01-15T00:01:01",
"label": "Webserver-Backup-2018",
"configs": [],
"disks": []
}
}
}Responses
200: A collection of the specified Linode's available backups.
The unique ID of this Backup.
This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
The current state of a specific Backup.
Whether this Backup is available for restoration.
Backups undergoing maintenance are not available for restoration.
The date the Backup was taken.
The date the Backup was most recently updated.
The date the Backup completed.
A label for Backups that are of type snapshot.
A list of the labels of the Configuration profiles that are part of the Backup.
A list of the disks that are part of the Backup.
An object representing a Backup or snapshot for a Linode with Backup service enabled.
The unique ID of this Backup.
This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
The current state of a specific Backup.
Whether this Backup is available for restoration.
Backups undergoing maintenance are not available for restoration.
The date the Backup was taken.
The date the Backup was most recently updated.
The date the Backup completed.
A label for Backups that are of type snapshot.
A list of the labels of the Configuration profiles that are part of the Backup.
A list of the disks that are part of the Backup.
An object representing a Backup or snapshot for a Linode with Backup service enabled.
The unique ID of this Backup.
This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
The current state of a specific Backup.
Whether this Backup is available for restoration.
Backups undergoing maintenance are not available for restoration.
The date the Backup was taken.
The date the Backup was most recently updated.
The date the Backup completed.
A label for Backups that are of type snapshot.
A list of the labels of the Configuration profiles that are part of the Backup.
A list of the disks that are part of the Backup.
default: Error
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.
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.
Snapshot Create
https://api.linode.com/v4/linode/instances/{linodeId}/backupsCreates a snapshot Backup of a Linode.
Important: If you already have a snapshot of this Linode, this is a destructive action. The previous snapshot will be deleted.
Path Parameters
The ID of the Linode the backups belong to.
Request Body Schema
The label for the new snapshot.
Request Samples
- Shell
- CLI
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
- 200
- default
{
"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: Snapshot request successful.
The current state of a specific Backup.
The date the Backup was taken.
The date the Backup was most recently updated.
The unique ID of this Backup.
A label for Backups that are of type snapshot.
This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time.
Whether this Backup is available for restoration.
Backups undergoing maintenance are not available for restoration.
The date the Backup completed.
A list of the labels of the Configuration profiles that are part of the Backup.
A list of the disks that are part of the Backup.
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).
default: Error
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.
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.