{"type":"api","title":"Get maintenance mode state of Crosswork","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/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":"Get maintenance mode state of Crosswork","description":"Retrieves the current maintenance mode status of Crosswork, including the current state (on/off/in progress), when it was last updated, and any relevant status messages. This endpoint helps monitor maintenance mode transitions and understand the current system operational state.","operationId":"BackupServices_RequestMaintenanceStatus","responses":{"200":{"description":"A successful response.","schema":{"type":"object","description":"Response containing the current maintenance mode status of Crosswork","properties":{"message":{"type":"string","description":"Status message about the current maintenance mode state"},"status":{"description":"Current maintenance mode status","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"},"lastUpdated":{"type":"string","description":"Timestamp when the maintenance mode status was last updated"}},"example":{"message":"Maintenance mode is currently enabled for backup operations","status":"Maintenance_Mode_On","lastUpdated":"2024-07-17T14:30:25Z"},"$$ref":"#/definitions/backupResponseMaintenanceStatus"},"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":[]}}}},"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestMaintenanceStatus","consumes":["application/json"],"produces":["application/json"],"method":"get","path":"/platform/maintenance/status"}}