mongodb_instances_backups

Overview

Name	mongodb_instances_backups
Type	Resource
Id	linode.databases.mongodb_instances_backups

Fields

Name	Datatype	Description
id	integer	The ID of the database backup object.
created	string	A time value given in a combined date and time format that represents when the database backup was created.
label	string	The database backup's label, for display purposes only. Must include only ASCII letters or numbers.
type	string	The type of database backup, determined by how the backup was created.

Methods

Name	Accessible by	Required Params	Description
getDatabasesMongoDBInstanceBackup	SELECT	backupId, instanceId	Display information for a single backup for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Note: New MongoDB Databases cannot currently be created.
getDatabasesMongoDBInstanceBackups	SELECT	instanceId	Display all backups for an accessible Managed MongoDB 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 MongoDB Database Backup Snapshot Create (POST /databases/mongodb/instances/{instanceId}/backups) command. Note: New MongoDB Databases cannot currently be created.
deleteDatabaseMongoDBInstanceBackup	DELETE	backupId, instanceId	Delete a single backup for an accessible Managed MongoDB Database. Requires read_write access to the Database. The Database must not be provisioning to perform this command. Note: New MongoDB Databases cannot currently be created.
_getDatabasesMongoDBInstanceBackup	EXEC	backupId, instanceId	Display information for a single backup for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Note: New MongoDB Databases cannot currently be created.
_getDatabasesMongoDBInstanceBackups	EXEC	instanceId	Display all backups for an accessible Managed MongoDB 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 MongoDB Database Backup Snapshot Create (POST /databases/mongodb/instances/{instanceId}/backups) command. Note: New MongoDB Databases cannot currently be created.
postDatabasesMongoDBInstanceBackup	EXEC	instanceId, data__label	Creates a snapshot backup of a Managed MongoDB 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. Note: New MongoDB Databases cannot currently be created.
postDatabasesMongoDBInstanceBackupRestore	EXEC	backupId, instanceId	Restore a backup to a Managed MongoDB 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. Note: New MongoDB Databases cannot currently be created.