{"type":"api","title":"Verify Crosswork readiness for geo redundancy restore","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e48c8a9a-1f0a-35b4-9617-f132aa89f152","info":{"title":"Crosswork Backup Restore Manager API","description":"Backup Restore Manager provides API methods for backup and restore operations on Crosswork. This includes backup, data only backup, restore, data only restore and migration.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/BACKUP_RESTORE/backup-restore-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v1","securityDefinitions":{"api_key":{"description":"security definitions details","type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"summary":"Verify Crosswork readiness for geo redundancy restore","description":"Performs pre-restore validation checks to ensure that Crosswork is ready for a geo redundancy restore operation. This includes verifying that the specified backup file exists at the remote location, checking system health, and validating restore compatibility.","operationId":"BackupServices_RequestVMGeoRedundancyRestoreVerify","responses":{"200":{"description":"A successful response.","schema":{"type":"object","description":"Result of a backup verification operation containing warnings and readiness status","properties":{"warnings":{"type":"array","description":"Array of warning messages related to backup readiness","items":{"type":"string"}}},"example":{"warnings":["Backup operation would request all applications to go in maintenance mode. Please run backup when no jobs are running in the system. It is recommended to perform backup in maintenance window."]},"$$ref":"#/definitions/backupBackupVerifyOpResult"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","description":"Standard error response containing detailed error information","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","format":"int32","description":"Error code"},"message":{"type":"string","description":"Detailed error message"},"details":{"type":"array","description":"Additional error details","items":{"type":"object","description":"Protocol Buffers Any message type for containing arbitrary serialized messages","properties":{"type_url":{"type":"string","description":"Type URL that identifies the message type"},"value":{"type":"string","format":"byte","description":"Serialized message value"}},"example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"description":"Verify if Crosswork is ready for a geo redundancy restore","name":"body","in":"body","required":true,"schema":{"type":"object","description":"Parameters required to verify if Crosswork is ready to perform a geo redundancy restore operation","properties":{"file_name":{"type":"string","title":"check file exists on the remote location with this name","description":"Name of the backup file to verify exists on the remote location before attempting restore"},"force":{"type":"boolean","description":"verify all checks except verifying if the file exists on the remote location.\r\nfile_name can not be empty, so use random/empty string if force needs to be true."}},"title":"check if Crosswork is ready to perform a geo redundancy restore","example":{"file_name":"geo-backup-2025-07-18.tar.gz","force":false},"$$ref":"#/definitions/backupGeoRedundancyRestoreVerifyOpReq"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestVMGeoRedundancyRestoreVerify","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/restore/verify/georedundancy"}}