{"type":"api","title":"Get maintenance mode state 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":"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 helps monitor maintenance mode transitions and current system 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":"Additional message about the maintenance mode status"},"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":"","status":"Maintenance_Mode_On_In_Progress","lastUpdated":"2025-05-16T04:44:01-07:00"},"$$ref":"#/definitions/backupResponseMaintenanceStatus"},"examples":{"example":{"message":"","status":"Maintenance_Mode_On_In_Progress","lastUpdated":"2025-05-16T04:44:01-07:00"}}},"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"}}},"tags":["BackupServices"],"__originalOperationId":"BackupServices_RequestMaintenanceStatus","consumes":["application/json"],"produces":["application/json"],"method":"get","path":"/platform/maintenance/status"}}