{"type":"api","title":"Restore Config Backup","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/1a66789f-a931-3445-bfb7-7bc8f1240ac1","info":{"title":"Device Configuration Restore API","description":"Device Configuration Restore API","version":"1.0.0","contact":{"name":"Crosswork Team,Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Device Configuration/device-config-restore-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1","description":"Generated server url"}]},"spec":{"tags":["Device Backup & Restore API"],"operationId":"restoreConfigBackup","requestBody":{"content":{"application/json":{"schema":{"description":"RestoreConfig","type":"object","properties":{"status_value":{"description":"Status Value","type":"integer","format":"int32"},"backup_before_restore":{"description":"Backup Before Restore","type":"boolean"},"vrf_name":{"description":"Vrf Name","type":"string"},"save_to_startup":{"description":"Save To Startup","type":"boolean"},"restore_from_case":{"description":"Restore From Case","type":"string","enum":["BACKUP_NAME","FILE_NAME","RESTOREFROM_NOT_SET"]},"continue_on_backup_failure":{"description":"Continue On Backup Failure","type":"boolean"},"reboot_after_restore":{"description":"Reboot After Restore","type":"boolean"},"restored_at":{"description":"Restored At","format":"date-time","type":"string"},"backup_name":{"description":"Backup Name","type":"string"},"restore_running":{"description":"Restore Running","type":"boolean"},"restore_admin":{"description":"Restore Admin","type":"boolean"},"restore_startup":{"description":"Restore Startup","type":"boolean"},"admin_password":{"description":"Admin Password","type":"string"},"device_uuid":{"description":"Device Uuid","type":"string"},"job_name":{"description":"Job Name","type":"string"},"status":{"description":"Status","type":"string","enum":["UNKNOWN","SUCCESS","FAILED","UNRECOGNIZED"]},"schedule":{"description":"Schedule","type":"object","properties":{"start_now":{"description":"Start Now","type":"boolean"},"recurrence_case":{"description":"Recurrence Case","type":"string","enum":["HOURLY","DAILY","WEEKLY","MONTHLY","RECURRENCE_NOT_SET"]},"start_at_case":{"description":"Start At Case","type":"string","enum":["START_AT_TIME","START_NOW","STARTAT_NOT_SET"]},"start_at_time":{"description":"Start At Time","format":"date-time","type":"string"},"end_at_case":{"description":"End At Case","type":"string","enum":["END_AT_TIME","END_AFTER","ENDAT_NOT_SET"]},"end_after":{"description":"End After","type":"integer","format":"int32"},"end_at_time":{"description":"End At Time","format":"date-time","type":"string"},"hourly":{"description":"Hourly","type":"object","properties":{"every_nhour":{"description":"Every N Hour","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/HourlyTrigger"},"daily":{"description":"Daily","type":"object","properties":{"every_nday":{"description":"Every N Day","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/DailyTrigger"},"weekly":{"description":"Weekly","type":"object","properties":{"days_of_week_count":{"description":"Days of Week Count","type":"integer","format":"int32"},"days_of_week":{"description":"Days of Week List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"description":"Items","type":"string"}}},"$$ref":"#/components/schemas/WeeklyTrigger"},"monthly":{"description":"Monthly","type":"object","properties":{"every_nmonth":{"description":"Every N Month","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/MonthlyTrigger"}},"$$ref":"#/components/schemas/JobSchedule"},"file_name":{"description":"FileName","type":"string"},"result":{"description":"Result","type":"string"}},"$$ref":"#/components/schemas/RestoreConfig"},"example":{"device_uuid":"d51d47c7-d8ae-44d0-befd-0f98123d33a5","schedule":{"start_now":true},"file_name":"RUNNINGCONFIG.cfg","restore_running":true,"restore_admin":false,"restore_startup":false,"vrf_name":"","backup_before_restore":false,"continue_on_backup_failure":false,"reboot_after_restore":false,"save_to_startup":false}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"description":"BackupRestoreJobResponse","type":"object","properties":{"job_id":{"description":"Job Id","type":"string"},"status_code":{"description":"Status Code","type":"integer","format":"int32"},"message":{"description":"Message","type":"string"}},"$$ref":"#/components/schemas/BackupRestoreJobResponse"},"example":{"status_code":202,"job_id":"RestoreConfig_10.104.120.42_2025-02-12_01:12:52","message":"Restore Config request is successful"}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"post","path":"/restore-config"}}