Databases
Managed PostgreSQL Database Backups List
https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backupsDisplay all backups for an accessible Managed PostgreSQL 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 PostgreSQL Database Backup Snapshot Create (POST /databases/postgresql/instances/{instanceId}/backups) command.
Path Parameters
The ID of the Managed PostgreSQL Database.
Query Parameters
The page of a collection to return.
The number of items to return per page.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/databases/postgresql/instances/123/backups
Response Samples
- 200
- default
{}Responses
200: Returns a paginated list of backups for the Managed PostgreSQL Database.
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.
Managed PostgreSQL Database Backup Snapshot Create
https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backupsCreates a snapshot backup of a Managed PostgreSQL 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
The ID of the Managed PostgreSQL Database.
Request Body Schema
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.
The Database cluster target.
If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-X POST -d '{
"label": "snapshot1",
"target": "primary"
}' \
https://api.linode.com/v4/databases/postgresql/instances/123/backups/
Response Samples
- 200
- default
{}Responses
200: Database snapshot backup request successful.
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.