{"type":"api","title":"Verify if Crosswork is ready for restore","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/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.","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"},"version":"7.2.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/BACKUP_RESTORE/backup-restore-v1-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v1"}],"securitySchemes":{"api_key":{"type":"apiKey","description":"security definitions details","name":"Authorization","in":"header"}}},"spec":{"tags":["BackupServices"],"summary":"Verify if Crosswork is ready for restore","description":"Performs pre-restore validation checks to ensure that Crosswork is in a suitable state for restore operations and that the specified backup is valid and compatible. This includes checking system health, backup integrity, and version compatibility.","operationId":"BackupServices_RequestVMRestoreVerify","requestBody":{"description":"Verify if Crosswork is ready for a restore","content":{"application/json":{"schema":{"type":"object","properties":{"backupJobName":{"type":"string","description":"Name of the backup job to verify for restore readiness"},"force":{"type":"boolean","description":"If true, skip certain verification checks"}},"description":"Request parameters for verifying if Crosswork is ready for a restore operation","example":{"backupJobName":"daily-backup-2025-07-18","force":false},"$$ref":"#/components/schemas/backupRestoreVerifyOpReq"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"warnings":{"type":"array","description":"Array of warning messages related to backup readiness","items":{"type":"string"}}},"description":"Result of a backup verification operation containing warnings and readiness status","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":"#/components/schemas/backupBackupVerifyOpResult"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code","format":"int32"},"message":{"type":"string","description":"Detailed error message"},"details":{"type":"array","description":"Additional error details","items":{"type":"object","properties":{"type_url":{"type":"string","description":"Type URL that identifies the message type"},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Serialized message value","format":"byte"}},"description":"Protocol Buffers Any message type for containing arbitrary serialized messages","example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/components/schemas/protobufAny"}}},"description":"Standard error response containing detailed error information","example":{"error":"","code":13,"message":"failed to marshal error message","details":[]},"$$ref":"#/components/schemas/runtimeError"}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"BackupServices_RequestVMRestoreVerify","method":"post","path":"/platform/restore/verify"}}