{"type":"api","title":"Take a Geo redundancy backup of Crosswork","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/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.","version":"2.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-v2-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v2","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Security definitions details."}}},"spec":{"summary":"Take a Geo redundancy backup of Crosswork","description":"Initiates a geo redundancy backup operation for Crosswork with configurable data store options. This operation creates a backup that can be used for disaster recovery across different geographical locations. The backup process can include PostgreSQL database, time series data, GlusterFS distributed file system, and Neo4j graph database depending on the configuration.","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":"backup-job-12345-abcde-67890"},"$$ref":"#/definitions/backupBackupOpResult"},"examples":{"example":{"jobId":"abcde-xdcred-gfsrte-khgtsedwa"}}},"default":{"description":"An unexpected error response.","schema":{"type":"object","description":"Standard error response containing error details, status code, message, and additional context","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"integer","format":"int32","description":"gRPC status code indicating the type of error"},"message":{"type":"string","description":"Detailed error message with context"},"details":{"type":"array","description":"Additional error details in protocol buffer format","items":{"type":"object","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","properties":{"type_url":{"type":"string","description":"URL that describes the type of the serialized message"},"value":{"type":"string","format":"byte","description":"Serialized protocol buffer message content"}},"example":{"type_url":"type.googleapis.com/error.details","value":"CgVoZWxsbw=="},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"Internal server error","code":13,"message":"Failed to process backup request due to insufficient resources","details":[]},"$$ref":"#/definitions/runtimeError"},"examples":{"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]}}}},"parameters":[{"name":"body","in":"body","description":"Parameters to take a Geo redundancy backup of Crosswork","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","description":"Unique name for the backup job (required for job identification and tracking)"},"force":{"type":"boolean","description":"If true, force the backup operation even if Crosswork is not in a healthy state"},"enable_maintenance_mode":{"type":"boolean","description":"If true, enable maintenance mode during the backup operation to ensure data consistency"},"backup_postgres":{"type":"boolean","description":"If true, include PostgreSQL database (robot-postgres) in the backup"},"backup_timeseries":{"type":"boolean","description":"If true, include time series data in the backup"},"backup_gluster":{"type":"boolean","description":"If true, include GlusterFS distributed file system data in the backup"},"backup_neo4j":{"type":"boolean","description":"If true, include Neo4j graph database data in the backup"}},"example":{"job_name":"geo_backup_prod_2024","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"}}