Databases

Managed MySQL Database Backups List

get
https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups

Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database auto type backups are created every 24 hours at 0:00 UTC. Each auto backup is retained for 7 days.

Database snapshot type backups are created by accessing the Managed MySQL Database Backup Snapshot Create (POST /databases/mysql/instances/{instanceId}/backups) command.

Path Parameters

instanceId
Required
integer

The ID of the Managed MySQL Database.

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 500]
Default: 100

The number of items to return per page.

Request Samples

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

Response Samples

{}

Responses

200: Returns a paginated list of backups for the Managed MySQL Database.

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.

Managed MySQL Database Backup Snapshot Create

post
https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups

Creates a snapshot backup of a Managed MySQL Database.

Requires read_write access to the Database.

Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.

Backups generated by this command have the type snapshot. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.

The Database must have an active status to perform this command. If another backup is in progress, it must complete before a new backup can be initiated.

Path Parameters

instanceId
Required
integer

The ID of the Managed MySQL Database.

Request Body Schema

label
Required
string [1 .. 30] characters

The label for the Database snapshot backup.

  • Must include only ASCII letters, numbers, or underscores.
  • Must be unique among other backup labels for this Database.
target
string
Enum: "primary""secondary"

The Database cluster target. If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.

Request Samples

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

Response Samples

{}

Responses

200: Database snapshot backup request successful.

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.