{"type":"api","title":"Set maintenance mode state of Crosswork","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-2/76fd4bb9d069fd2530d7a02f0b3a4ca00eccfd35/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":"7.2.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":"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.","operationId":"BackupServices_RequestMaintenanceMode","requestBody":{"description":"Set maintenance mode state of Crosswork","content":{"application/json":{"schema":{"type":"object","properties":{"isSetMaintenance":{"type":"boolean","description":"If true, enable maintenance mode; if false, disable maintenance mode"}},"description":"Request to set the maintenance mode state of Crosswork","example":{"isSetMaintenance":true},"$$ref":"#/components/schemas/backupRequestMaintenanceModeOp"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Descriptive message about the maintenance mode operation"},"requestStatus":{"type":"string","description":"Status of a maintenance mode request operation","default":"Maintenance_Mode_Request_Status_Success","enum":["Maintenance_Mode_Request_Status_Success","Maintenance_Mode_Request_Status_Failed"],"$$ref":"#/components/schemas/backupMaintenanceModeRequestStatusType"},"modeStatus":{"type":"string","description":"Current status of the maintenance mode in Crosswork","default":"Maintenance_Mode_Off","enum":["Maintenance_Mode_Off","Maintenance_Mode_On","Maintenance_Mode_On_In_Progress","Maintenance_Mode_Off_In_Progress"],"$$ref":"#/components/schemas/backupMaintenanceModeStatusType"}},"description":"Response from a maintenance mode operation request containing status and result information","example":{"message":"Processing ON request.","requestStatus":"Maintenance_Mode_Request_Status_Success","modeStatus":"Maintenance_Mode_Off"},"$$ref":"#/components/schemas/backupResponseMaintenanceModeOp"},"example":{"message":"Processing ON request.","requestStatus":"Maintenance_Mode_Request_Status_Success","modeStatus":"Maintenance_Mode_Off"}}}},"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_RequestMaintenanceMode","method":"post","path":"/platform/maintenance/set"}}