{"type":"api","title":"Take a backup of Crosswork","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/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":"Take a backup of Crosswork","description":"Initiates a full backup operation that captures the complete Crosswork system state including all application data, configurations, system files, and infrastructure components. This comprehensive backup enables complete system recovery and is recommended for disaster recovery scenarios.","operationId":"BackupServices_RequestVMBackup","responses":{"200":{"description":"A successful response.","schema":{"type":"object","description":"Result of a backup operation containing the job identifier","properties":{"jobId":{"type":"string","description":"Unique identifier for the backup job"}},"example":{"jobId":"job-id"},"$$ref":"#/definitions/backupBackupOpResult"}},"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":"Take a backup of Crosswork","name":"body","in":"body","required":true,"schema":{"type":"object","description":"Request parameters for initiating a backup operation on Crosswork","properties":{"jobName":{"type":"string","description":"Unique name for the backup job"},"force":{"type":"boolean","description":"If true, force the backup operation even if Crosswork is not in a healthy state"},"nsoBackupDisable":{"type":"boolean","description":"If true, disable NSO backup during the operation"}},"example":{"jobName":"daily-backup-2025-07-18","force":false,"nsoBackupDisable":false},"$$ref":"#/definitions/backupBackUpOpReq"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestVMBackup","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/backup/init"}}