{"type":"api","title":"Get Config Preferences","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/75642bd0-bd35-3880-9593-c04c653a6b33","info":{"title":"Device Configuration Preferences API","description":"Device Configuration Preferences 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-preferences-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1/device-config-preferences","description":"Generated server url"}]},"spec":{"tags":["Device Configuration Preferences"],"operationId":"getConfigPreferences","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Preferences data","properties":{"timeout":{"type":"integer","description":"Time out value","format":"int32"},"max_days_to_retain_jobs":{"type":"integer","description":"Maximum job retention days","format":"int32"},"hold_off_timer":{"type":"integer","description":"Hold off timer","format":"int32"},"max_backups_to_retain":{"type":"integer","description":"Maximum number of backups to keep","format":"int32"},"max_days_to_retain_backups":{"type":"integer","description":"Maximum number of days to keep backup","format":"int32"},"is_nso_configured":{"type":"boolean","description":"Shows if NSO is configured"},"enable_syslog_traps_on_device":{"type":"boolean","description":"Enable/Disable syslogs and traps on device"},"backup_config_on_device_add":{"type":"boolean","description":"Enable/Disable Config backup on new device addition"},"backup_config_on_config_change":{"type":"boolean","description":"Enable/Disable Config backup for any config change in device"},"initiate_backup_config_from_ems":{"type":"boolean","description":"Enable/Disable Config backup from EMS"},"alarm_threshold":{"type":"integer","description":"Thresold value to raise alarm","format":"int32"}},"$$ref":"#/components/schemas/ConfigPreferences"},"examples":{"get":{"summary":"Get config preferences example","value":{"timeout":60,"hold_off_timer":60,"max_backups_to_retain":5,"max_days_to_retain_backups":7,"alarm_threshold":5,"max_days_to_retain_jobs":7,"backup_config_on_device_add":true,"backup_config_on_config_change":false,"initiate_backup_config_from_ems":true,"enable_syslog_traps_on_device":true,"is_nso_configured":true},"$$ref":"#/components/examples/GetConfigPreferences"}}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"get","path":"/config-settings"}}