{"type":"api","title":"Take a data only backup of Crosswork","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/e1ae91f25de62367ac175351487a12de3ae46a25/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":"3.0.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":"Take a data only backup of Crosswork","description":"Creates a data-only backup of Crosswork that includes essential application data, configurations, and database content while excluding system files and infrastructure components. This type of backup is faster than a full backup and focuses on preserving user data and application state.","operationId":"BackupServices_RequestVMBackupDataOnly","requestBody":{"description":"Take a data only backup of Crosswork.","content":{"application/json":{"schema":{"type":"object","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"}},"description":"Request parameters for initiating a backup operation on Crosswork","example":{"jobName":"daily-backup-2025-07-18","force":false,"nsoBackupDisable":false},"$$ref":"#/components/schemas/backupBackUpOpReq"}}},"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":"job-id"},"$$ref":"#/components/schemas/backupBackupOpResult"}}}},"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_RequestVMBackupDataOnly","method":"post","path":"/platform/backup/dataonly"}}