{"type":"api","title":"Perform upgrade restore of Crosswork from backup","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/21eb1d117a633ad17a20da730c09f519133958a8/6c49d803-9bf6-348b-b43b-bf553e163c6f","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":"2.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/BACKUP_RESTORE/backup-restore-v2-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cw_ip}:30603/crosswork/platform/v2"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security definitions details.","name":"Authorization","in":"header"}}},"spec":{"tags":["BackupServices"],"summary":"Perform upgrade restore of Crosswork from backup","description":"Initiates an upgrade restore operation that restores Crosswork from a backup while simultaneously upgrading it to a newer version. This operation combines restoration and migration functionality, allowing you to restore data from an older version backup to a newer Crosswork installation.","operationId":"BackupServices_RequestVMRestoreUpgrade","requestBody":{"description":"Parameters to perform a upgrade restore of Crosswork from a backup","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Name of the backup file to use for the upgrade restore operation"},"force":{"type":"boolean","description":"If true, force the upgrade restore operation even if Crosswork is not in a healthy state"}},"description":"Parameters required to perform an upgrade restore (migration) operation from a backup file","example":{"filename":"crosswork-backup-v6.0.tar.gz","force":false},"$$ref":"#/components/schemas/backupMigrationOpReq"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique identifier for the backup job"}},"description":"Result of a backup operation containing the job identifier","example":{"jobId":"backup-job-12345-abcde-67890"},"$$ref":"#/components/schemas/backupBackupOpResult"}},"example":{"example":{"jobId":"abcde-xdcred-gfsrte-khgtsedwa"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"gRPC status code indicating the type of error","format":"int32"},"message":{"type":"string","description":"Detailed error message with context"},"details":{"type":"array","description":"Additional error details in protocol buffer format","items":{"type":"object","properties":{"type_url":{"type":"string","description":"URL that describes the type of the serialized message"},"value":{"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","description":"Serialized protocol buffer message content","format":"byte"}},"description":"A generic message type that can hold any serialized protocol buffer message along with a URL that describes the type of the serialized message","example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/components/schemas/protobufAny"}}},"description":"Standard error response containing error details, status code, message, and additional context","example":{"error":"Internal server error","code":13,"message":"Failed to process backup request due to insufficient resources","details":[]},"$$ref":"#/components/schemas/runtimeError"}},"example":{"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"BackupServices_RequestVMRestoreUpgrade","method":"post","path":"/platform/migration"}}