v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Backups

Restore a backup

Initiates a restore using the backup_id provided

post/organizations/{organization_id}/accounts/{account_id}/backups/{backup_id}/restore

Path parameters

organization_idstring required

Organization Id of the Organization that you are working with. This can be found by looking at the organization id in the URL of the dashboard. These are randomly generated alphanumber values

account_idstring required

Account id of the CloudRanger Account that you are managing inside an organization, these can be found by call the /organizations/{organization_id}/accounts endpoints which returns all accounts inside an Organization These are randomly generated alphanumber values

backup_idstring required

The unique ID of an AWS backup. Example of the backup ID is {accountID__backup_id_btdc} for restoring an airgapped backup and {accountID__backup_id} for restoring a non-airgapped backup. CloudRanger will use these through the application to locate and associate backups with policies and resources for the purpose of restore and retention.

Request body

target_account_idstring
target_regionstring
typestring

ami for AMI restore, instance for Snapshot restore and volume for Volume restore

originstring

value should be restore

Response

200 response

__AccountIdstring
__OrganizationIdstring
AllocatedStorageinteger
AssociatedRolesstring[]
AutoMinorVersionUpgradeboolean
AvailabilityZonestring
BackupRetentionPeriodinteger
CACertificateIdentifierstring
CopyTagsToSnapshotboolean
DBInstanceArnstring
DBInstanceClassstring
DBInstanceIdentifierstring
DbInstancePortinteger
DBInstanceStatusstring
DbiResourceIdstring
DBSecurityGroupsstring[]
DeletionProtectionboolean
DomainMembershipsstring[]
EnabledCloudwatchLogsExportsstring[]
Enginestring
EngineVersionstring
IAMDatabaseAuthenticationEnabledboolean
Idstring
Iopsinteger
LicenseModelstring
MasterUsernamestring
MonitoringIntervalinteger
MultiAZboolean
ObjectTypestring
PendingModifiedValuesobject
PerformanceInsightsEnabledboolean
postDatestring date-time
PreferredBackupWindowstring
PreferredMaintenanceWindowstring
ProcessorFeaturesstring[]
PubliclyAccessibleboolean
ReadReplicaDBClusterIdentifiersstring[]
ReadReplicaDBInstanceIdentifiersstring[]
Regionstring
Sourcestring
StatusInfosstring[]
StorageEncryptedboolean
StorageTypestring
Tagsobject[]
Typestring