{"type":"api","title":"Set maintenance mode state 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":"Set maintenance mode state of Crosswork","description":"Enables or disables maintenance mode for Crosswork, which temporarily suspends normal operations to allow for safe backup, restore, or maintenance activities. When enabled, this mode ensures data consistency during critical operations by preventing new jobs from starting and allowing existing jobs to complete safely.","operationId":"BackupServices_RequestMaintenanceMode","responses":{"200":{"description":"A successful response.","schema":{"type":"object","description":"Response containing the result of a maintenance mode operation on Crosswork","properties":{"message":{"type":"string","description":"Status message about the maintenance mode operation result"},"requestStatus":{"description":"Status of the maintenance mode request (success or failed)","type":"string","enum":["Maintenance_Mode_Request_Status_Success","Maintenance_Mode_Request_Status_Failed"],"default":"Maintenance_Mode_Request_Status_Success","$$ref":"#/definitions/backupMaintenanceModeRequestStatusType"},"modeStatus":{"description":"Current maintenance mode status after the operation","type":"string","enum":["Maintenance_Mode_Off","Maintenance_Mode_On","Maintenance_Mode_On_In_Progress","Maintenance_Mode_Off_In_Progress"],"default":"Maintenance_Mode_Off","$$ref":"#/definitions/backupMaintenanceModeStatusType"}},"example":{"message":"Processing maintenance mode request","requestStatus":"Maintenance_Mode_Request_Status_Success","modeStatus":"Maintenance_Mode_On"},"$$ref":"#/definitions/backupResponseMaintenanceModeOp"},"examples":{"example":{}}},"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 set maintenance mode state of Crosswork","required":true,"schema":{"type":"object","description":"Request object for setting the maintenance mode state of Crosswork","properties":{"isSetMaintenance":{"type":"boolean","description":"Flag to enable (true) or disable (false) maintenance mode on Crosswork"}},"example":{"isSetMaintenance":true},"$$ref":"#/definitions/backupRequestMaintenanceModeOp"}}],"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestMaintenanceMode","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/platform/maintenance/set"}}