{"type":"api","title":"Take a Geo redundancy backup of Crosswork","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":"Take a Geo redundancy backup of Crosswork","description":"Initiates a geo-redundant backup operation with configurable data store options. This specialized backup can selectively include PostgreSQL databases, time series data, GlusterFS storage, and Neo4j databases, designed for geographic redundancy and disaster recovery across multiple locations.","operationId":"BackupServices_RequestVMBackupGeoRedundancy","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 Geo redundancy backup of Crosswork","name":"body","in":"body","required":true,"schema":{"type":"object","description":"Request parameters for initiating a geo redundancy backup operation on Crosswork with configurable data store options","properties":{"job_name":{"type":"string","title":"each job requires a unique name","description":"Unique name for the backup job (required for job identification and tracking)"},"force":{"type":"boolean","title":"if false, backup operation is attempted even if Crosswork is not healthy","description":"If true, force the backup operation even if Crosswork is not in a healthy state"},"enable_maintenance_mode":{"type":"boolean","title":"if true, maintenance mode is enabled/set during the backup operation","description":"If true, enable maintenance mode during the backup operation to ensure data consistency"},"backup_postgres":{"type":"boolean","title":"if true, postgres (robot-postgres) will be backed up","description":"If true, include PostgreSQL database (robot-postgres) in the backup"},"backup_timeseries":{"type":"boolean","title":"if true, timeseries will be backed up","description":"If true, include time series data in the backup"},"backup_gluster":{"type":"boolean","title":"if true, gluster will be backed up","description":"If true, include GlusterFS distributed file system data in the backup"},"backup_neo4j":{"type":"boolean","title":"if true, neo4j will be backed up","description":"If true, include Neo4j graph database data in the backup"}},"title":"Details needed to run a Geo redundancy backup operation","example":{"job_name":"geo-backup-2025-07-18","force":false,"enable_maintenance_mode":true,"backup_postgres":true,"backup_timeseries":true,"backup_gluster":true,"backup_neo4j":true},"$$ref":"#/definitions/backupGeoRedundancyBackUpOpReq"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestVMBackupGeoRedundancy","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/backup/georedundancy"}}