{"restSchemaVersion":"1.0","errors":[{"error_id":"INTERNAL_ERROR","description":"Internal server error.","http_status":"500"},{"error_id":"AUTH_REQUIRED","description":"The requested resource requires authentication.","http_status":"401"},{"error_id":"AUTH_INVALID_CREDENTIALS","description":"Invalid username and\/or password.","http_status":"401"},{"error_id":"AUTH_INVALID_SESSION","description":"Session ID is invalid.","http_status":"401"},{"error_id":"AUTH_EXPIRED_PASSWORD","description":"The password must be changed. Access only to password change resources.","http_status":"403"},{"error_id":"AUTH_DISABLED_ACCOUNT","description":"Account is either temporarily or permanently disabled.","http_status":"403"},{"error_id":"AUTH_FORBIDDEN","description":"User is not authorized to access the requested resource.","http_status":"403"},{"error_id":"AUTH_INVALID_TOKEN","description":"OAuth access token is invalid.","http_status":"401"},{"error_id":"AUTH_EXPIRED_TOKEN","description":"OAuth access token is expired.","http_status":"401"},{"error_id":"AUTH_INVALID_CODE","description":"OAuth access code is invalid.","http_status":"401"},{"error_id":"AUTH_EXPIRED_CODE","description":"OAuth access code is expired.","http_status":"401"},{"error_id":"RESOURCE_NOT_FOUND","description":"Requested resource was not found.","http_status":"404"},{"error_id":"HTTP_INVALID_METHOD","description":"Requested method is not available for this resource.","http_status":"405"},{"error_id":"HTTP_INVALID_HEADER","description":"An HTTP header was malformed.","http_status":"400"},{"error_id":"REQUEST_INVALID_INPUT","description":"Malformed input structure.","http_status":"400"},{"error_id":"URI_INVALID_PARAMETER","description":"URI parameter is not supported or malformed.","http_status":"400"},{"error_id":"URI_MISSING_PARAMETER","description":"Missing required parameter.","http_status":"400"}],"name":"npm.profiler_backup","title":"Riverbed Profiler Backup API.","version":"1.0","schemas":[],"defaultAuthorization":"required","servicePath":"\/api\/npm.profiler_backup\/1.0","resources":{"Restore":{"methods":{"Start new Restore":{"description":"Get Restore Status.","request":{"properties":{"security_pwd":{"description":"Password protecting the sensitive data in the backup file.","required":false,"type":"string"},"exclude_logs":{"description":"Exclude flow, rollup and identity logs. Default value: true.","required":false,"type":"string"},"password":{"description":"SSH password to connect to the remote system.","required":false,"type":"string"},"path":{"description":"Directory path on the remote system.","required":false,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":false,"type":"string"},"email":{"description":"Notify this email address when the restore is completed.","required":false,"type":"string"},"include_precomputed":{"description":"Include Precomputed tables. Default value: false.","required":false,"type":"string"},"exclude_reports":{"description":"Exclude saved reports. Default value: false.","required":false,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":false,"type":"string"}},"description":"Start restoring from a backup image.","type":"object","id":"ApplyRestore","example":[]},"httpmethod":"POST","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"path":"restore","authorization":"required"},"Restore status":{"description":"Get Restore Status.","response":{"properties":{"last_successful":{"properties":{"path":{"description":"Directory path on the remote system.","required":true,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":true,"type":"string"},"subdir":{"description":"Sub-directory path on the remote system. It's in form: {datatime}_{hr}{min}.","required":true,"type":"string"},"timestamp":{"description":"Unix time (epoch) of when the restore was started.","required":true,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":true,"type":"string"}},"description":"Information for last successful restore.","required":true,"type":"object","id":"LastRestore"},"running":{"properties":{"path":{"description":"Directory path on the remote system.","required":false,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":false,"type":"string"},"status":{"description":"Status of currently running or finished restore.","required":true,"type":"string","enum":["COMPLETED","EXECUTING","ERROR","NONE"]},"message":{"description":"Error message if the restore has failed.","required":false,"type":"string"},"timestamp":{"description":"Unix time (epoch) of when the backup was started.","required":false,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":false,"type":"string"}},"description":"Information for currently running or last running restore.","required":true,"type":"object","id":"RunningRestore"}},"description":"Restore Status.","type":"object","id":"Restore"},"httpmethod":"GET","formats":["xml","json"],"authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"path":"restore","authorization":"required"}}},"Backups":{"methods":{"Backup status":{"description":"Get Backup Status.","response":{"properties":{"last_successful":{"properties":{"path":{"description":"Directory path on the remote system.","required":true,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":true,"type":"string"},"subdir":{"description":"Sub-directory path on the remote system. It's in form: {datatime}_{hr}{min}.","required":true,"type":"string"},"timestamp":{"description":"Unix time (epoch) of when the backup was started.","required":true,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":true,"type":"string"}},"description":"Information for last successful backup.","required":true,"type":"object","id":"LastBackup"},"running":{"properties":{"path":{"description":"Directory path on the remote system.","required":false,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":false,"type":"string"},"status":{"description":"Status of currently running or finished backup.","required":true,"type":"string","enum":["COMPLETED","EXECUTING","ERROR","NONE"]},"message":{"description":"Error message if the backup has failed.","required":false,"type":"string"},"timestamp":{"description":"Unix time (epoch) of when the backup was started.","required":false,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":false,"type":"string"}},"description":"Information for currently running or last running backup.","required":true,"type":"object","id":"RunningBackup"}},"description":"Backup Status.","type":"object","id":"Backup","example":{"running":{"status":"EXECUTING","username":"testing","timestamp":"1595875578","host":"bach","path":"\/test\/nas\/mybackup"},"last_successful":{"username":"testing","path":"\/test\/nas\/mybackup","host":"bach","subdir":"20200727_1430","timestamp":"1595874702"}}},"httpmethod":"GET","formats":["xml","json"],"authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"path":"backups","authorization":"required"},"Start new Backup":{"description":"Get Backup Status.","request":{"properties":{"security_pwd":{"description":"Password to protect the sensitive data in the backup file. Restoring the appliance from this backup will require the user to enter this password.","required":false,"type":"string"},"exclude_logs":{"description":"Exclude flow, rollup and identity logs. Default value: true.","required":false,"type":"string"},"password":{"description":"SSH password to connect to the remote system.","required":false,"type":"string"},"path":{"description":"Directory path on the remote system.","required":false,"type":"string"},"username":{"description":"SSH username to connect to the remote system.","required":false,"type":"string"},"email":{"description":"Notify this email address when the backup is completed.","required":false,"type":"string"},"include_precomputed":{"description":"Include Precomputed tables. Default value: false.","required":false,"type":"string"},"exclude_reports":{"description":"Exclude saved reports. Default value: false.","required":false,"type":"string"},"host":{"description":"Remote system: host name or IP Address.","required":false,"type":"string"}},"description":"Start new backup.","type":"object","id":"CreateBackup","example":{"exclude_logs":true,"username":"testing","security_pwd":"test","exclude_reports":true,"include_precomputed":false,"host":"bach","path":"test\/nas\/mybackup","password":"testing","email":""}},"httpmethod":"POST","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"path":"backups","authorization":"required"}}}},"description":""}