Skip to main content

postgresql_instances_backups

Overview

Namepostgresql_instances_backups
TypeResource
Idlinode.databases.postgresql_instances_backups

Fields

NameDatatypeDescription
idintegerThe ID of the database backup object.
createdstringA time value given in a combined date and time format that represents when the database backup was created.
labelstringThe database backup's label, for display purposes only.

Must include only ASCII letters or numbers.
typestringThe type of database backup, determined by how the backup was created.

Methods

NameAccessible byRequired ParamsDescription
getDatabasesPostgreSQLInstanceBackupSELECTbackupId, instanceIdDisplay information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
getDatabasesPostgreSQLInstanceBackupsSELECTinstanceIdDisplay 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.
deleteDatabasePostgreSQLInstanceBackupDELETEbackupId, instanceIdDelete a single backup for an accessible Managed PostgreSQL Database.

Requires read_write access to the Database.

The Database must not be provisioning to perform this command.
_getDatabasesPostgreSQLInstanceBackupEXECbackupId, instanceIdDisplay information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.
_getDatabasesPostgreSQLInstanceBackupsEXECinstanceIdDisplay 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.
postDatabasesPostgreSQLInstanceBackupEXECinstanceId, data__labelCreates 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.
postDatabasesPostgreSQLInstanceBackupRestoreEXECbackupId, instanceIdRestore a backup to a Managed PostgreSQL Database on your Account.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Note: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

Note: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.