{"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"}],"title":"Riverbed Cascade Gateway REST API.","description":"<h2>Overview<\/h2>\n\n<p>\nThe documentation pages in this section describe\nthe RESTful APIs included with Cascade Gateway products. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed and how to access it.\n<\/p>\n\n<p>\nThe following information can be accessed via the API:\n<\/p>\n<ul>\n  <li>Perform System operations<\/li> \n  <li>Information about system users<\/li>\n<\/ul>\n\n<p>\nDetails about REST resources can be found in the <b>Resources<\/b>\nsection. This overview continues with how to run reports and retrieve\ndata from them.\n<\/p>\n\n<h2>Authentication<\/h2>\n\n<p>\nAll REST requests must be authenticated. The <b>Authentication<\/b>\nsection of the Common 1.0 API describes which authentication methods\nare presently supported. There are also examples that show how to use\neach of the different authentication methods.\n<\/p>\n\n<h2>\/api\/gateway\/1.2 to \/api\/gateway\/1.3 Changelog<\/h2>\n\n<p>\n<b>Added the following resources:<\/b>\n<\/p>\n<p>\n  <ul>\n    <li>\/api\/gateway\/1.3\/users\/tacacs\/test_server<\/li>\n    <li>\/api\/gateway\/1.3\/users\/tacacs\/test_user<\/li>\n  <\/ul>\n  For more information please read the Resources documentation.\n<\/p>\n","version":"1.3","defaultAuthorization":"required","servicePath":"\/api\/gateway\/1.3","schemas":[],"resources":{"Ping":{"methods":{"Ping":{"description":"Simple test of service availability.","httpmethod":"GET","path":"ping","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"}}},"System":{"methods":{"Start all processes (one module)":{"description":"Start all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system\/{module}\/status\" to poll for status. The {module} can be either the IP Address or the module name.","httpmethod":"POST","path":"system\/{module}\/start","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Get status of all processes":{"description":"Get status of all system processes. On Enterprise systems, get system process statuses on all modules.","formats":["xml","json"],"httpmethod":"GET","path":"system\/status","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"SystemStatus object.","items":{"description":"SystemProcess object.","required":false,"properties":{"process_id":{"description":"Process ID.","required":false,"type":"string"},"process_name":{"description":"Process name.","required":true,"type":"string"},"module_name":{"description":"Module name. Available on Enterprise systems only.","required":false,"type":"string"},"status":{"description":"Process status.","required":true,"type":"string","enum":["Running","Stopped"]},"module_ipaddr":{"description":"Module IP address. Available on Enterprise systems only.","required":false,"type":"string"}},"id":"SystemProcess","type":"object"},"id":"SystemStatus","type":"array","example":[{"process_id":"25096","process_name":"memmonitor","status":"Running"},{"process_name":"healthd","status":"Stopped"},{"process_id":"25092","process_name":"diskmon","status":"Running"},{"process_id":"25123","process_name":"dispatcher","status":"Running"},{"process_name":"analyzer","status":"Stopped"}]},"authorization":"required"},"Kill all processes":{"description":"Kill all system processes. The operation is asynchronous. Use \"GET system\/status\" to poll for status. On Enterprise systems, kill system processes on all modules. Warning: this operation can result in data being corrupted.","httpmethod":"POST","path":"system\/kill","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Restart all processes":{"description":"Restart all system processes. The operation is asynchronous. Use \"GET system\/status\" to poll for status. On Enterprise systems, stop system processes on all modules.","httpmethod":"POST","path":"system\/restart","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Start all processes":{"description":"Start all system processes. The operation is asynchronous. Use \"GET system\/status\" to poll for status. On Enterprise systems, start system processes on all modules.","httpmethod":"POST","path":"system\/start","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Restart all processes (one module)":{"description":"Restart all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system\/{module}\/status\" to poll for status. The {module} can be either the IP Address or the module name.","httpmethod":"POST","path":"system\/{module}\/restart","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Stop all processes (one module)":{"description":"Stop all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system\/{module}\/status\" to poll for status. The {module} can be either the IP Address or the module name.","httpmethod":"POST","path":"system\/{module}\/stop","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Get status of all processes (one module)":{"description":"Get status of all system processes on one module on Enterprise systems. The {module} can be either the IP Address or the module name.","formats":["xml","json"],"httpmethod":"GET","path":"system\/{module}\/status","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"SystemStatus object.","items":{"description":"SystemProcess object.","required":false,"properties":{"process_id":{"description":"Process ID.","required":false,"type":"string"},"process_name":{"description":"Process name.","required":true,"type":"string"},"module_name":{"description":"Module name. Available on Enterprise systems only.","required":false,"type":"string"},"status":{"description":"Process status.","required":true,"type":"string","enum":["Running","Stopped"]},"module_ipaddr":{"description":"Module IP address. Available on Enterprise systems only.","required":false,"type":"string"}},"id":"SystemProcess","type":"object"},"id":"SystemStatus","type":"array","example":[{"process_id":"25096","process_name":"memmonitor","status":"Running"},{"process_name":"healthd","status":"Stopped"},{"process_id":"25092","process_name":"diskmon","status":"Running"},{"process_id":"25123","process_name":"dispatcher","status":"Running"},{"process_name":"analyzer","status":"Stopped"}]},"authorization":"required"},"Shutdown":{"description":"Shutdown the system. The operation is asynchronous.","httpmethod":"POST","path":"system\/shutdown","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Reboot":{"description":"Reboot the system. The operation is asynchronous.","httpmethod":"POST","path":"system\/reboot","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Stop all processes":{"description":"Stop all system processes. The operation is asynchronous. Use \"GET system\/status\" to poll for status. On Enterprise systems, stop system processes on all modules.","httpmethod":"POST","path":"system\/stop","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Kill all processes (one module)":{"description":"Kill all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system\/{module}\/status\" to poll for status. The {module} can be either the IP Address or the module name. Warning: this operation can result in data being corrupted.","httpmethod":"POST","path":"system\/{module}\/kill","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"}}},"Users":{"methods":{"List users":{"description":"Get a list of user accounts.","formats":["xml","json"],"httpmethod":"GET","path":"users","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"List of user accounts on the system.","items":{"description":"User account.","required":false,"properties":{"enabled":{"description":"Boolean flag indicating if the user account is enabled.","required":true,"type":"string"},"last_name":{"description":"Last name of the user.","required":true,"type":"string"},"id":{"description":"Numeric ID of the user that the system uses internally and in the API.","required":true,"type":"number"},"last_login":{"description":"Time of last login. Unix time (epoch).","required":true,"type":"number"},"authentication_type":{"description":"Type of authentication for the user, such as Local or RADIUS.","required":true,"type":"string","enum":["Local","Remote"]},"username":{"description":"User name (short name) that identifies the user to the system, such as 'admin'.","required":true,"type":"string"},"authorization_type":{"description":"Type of authorization for the user, such as Local or RADIUS.","required":true,"type":"string","enum":["Local","Remote"]},"role":{"description":"Role of the user. Defines permissions.","required":true,"type":"string","enum":["Developer","Administrator","Operator","Monitor","Event_Viewer","Dashboard_Viewer"]},"first_name":{"description":"First name of the user.","required":true,"type":"string"},"last_access":{"description":"Time of last access to the system. Unix time (epoch).","required":true,"type":"number"},"view_packet_details":{"description":"Boolean flag indicating if the user has access to packet data.","required":false,"type":"string"},"last_authentication":{"description":"Time of last authentication. Unix time (epoch).","required":true,"type":"number"},"view_user_information":{"description":"Boolean flag indicating if the user has access to identity information, such as Active Directory information.","required":false,"type":"string"},"login_timeout":{"description":"Timeout (in seconds) during which the user cannot log in to the system because of security policies.","required":true,"type":"number"}},"id":"User","type":"object"},"id":"Users","type":"array","example":[{"username":"admin","last_authentication":1352313328,"first_name":"Jonh","last_name":"Smith","authorization_type":"Local","enabled":true,"view_user_information":true,"authentication_type":"Local","role":"Administrator","login_timeout":900,"last_login":1352313328,"last_access":1352313328,"id":123},{"username":"admin2","last_authentication":1352313328,"first_name":"Mark","last_name":"Greg","authorization_type":"Local","enabled":true,"view_user_information":true,"authentication_type":"Local","role":"Administrator","login_timeout":900,"last_login":1352313328,"last_access":1352313328,"id":124}]},"authorization":"required"},"Re-authenticate user":{"description":"Re-authenticate user account. Requires basic authentication.","httpmethod":"GET","path":"users\/re_authenticate","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"authorization":"required"},"Get user":{"description":"User account by user ID.","formats":["xml","json"],"httpmethod":"GET","path":"users\/{user_id}","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"User account.","properties":{"enabled":{"description":"Boolean flag indicating if the user account is enabled.","required":true,"type":"string"},"last_name":{"description":"Last name of the user.","required":true,"type":"string"},"id":{"description":"Numeric ID of the user that the system uses internally and in the API.","required":true,"type":"number"},"last_login":{"description":"Time of last login. Unix time (epoch).","required":true,"type":"number"},"authentication_type":{"description":"Type of authentication for the user, such as Local or RADIUS.","required":true,"type":"string","enum":["Local","Remote"]},"username":{"description":"User name (short name) that identifies the user to the system, such as 'admin'.","required":true,"type":"string"},"authorization_type":{"description":"Type of authorization for the user, such as Local or RADIUS.","required":true,"type":"string","enum":["Local","Remote"]},"role":{"description":"Role of the user. Defines permissions.","required":true,"type":"string","enum":["Developer","Administrator","Operator","Monitor","Event_Viewer","Dashboard_Viewer"]},"first_name":{"description":"First name of the user.","required":true,"type":"string"},"last_access":{"description":"Time of last access to the system. Unix time (epoch).","required":true,"type":"number"},"view_packet_details":{"description":"Boolean flag indicating if the user has access to packet data.","required":false,"type":"string"},"last_authentication":{"description":"Time of last authentication. Unix time (epoch).","required":true,"type":"number"},"view_user_information":{"description":"Boolean flag indicating if the user has access to identity information, such as Active Directory information.","required":false,"type":"string"},"login_timeout":{"description":"Timeout (in seconds) during which the user cannot log in to the system because of security policies.","required":true,"type":"number"}},"id":"User","type":"object","example":{"username":"admin","last_authentication":1352313328,"first_name":"Jonh","last_name":"Smith","authorization_type":"Local","enabled":true,"view_user_information":true,"authentication_type":"Local","role":"Administrator","login_timeout":900,"last_login":1352313328,"last_access":1352313328,"id":123}},"authorization":"required"},"Test RADIUS user":{"description":"Test a RADIUS user.","parameters":{"password":{"required":true,"type":"string","description":"RADIUS password."},"username":{"required":true,"type":"string","description":"RADIUS username."}},"formats":["xml","json"],"request":{"description":"RemoteTestUserRequest object.","properties":{"password":{"description":"password.","required":true,"type":"string"},"username":{"description":"user name.","required":true,"type":"string"}},"id":"RemoteTestUserRequest","type":"object","example":{"username":"testusername","password":"testpassword"}},"httpmethod":"POST","path":"users\/radius\/test_user","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"RemoteTestUserResponse object.","properties":{"role_id":{"description":"Matched role ID.","required":true,"type":"number"},"error_message":{"description":"Error message.","required":true,"type":"string"},"permission":{"description":"Matched permission name.","required":true,"type":"string"},"server_type":{"description":"Indicates the type of the server being tested: RADIUS(2) or TACACS+(3).","required":true,"type":"number"},"role":{"description":"Matched role name.","required":true,"type":"string"},"details":{"description":"Remote user test details.","required":true,"type":"string"},"permission_id":{"description":"Matched permission ID.","required":true,"type":"string"},"server_ip":{"description":"Remote Server IP address.","required":true,"type":"string"},"authenticated":{"description":"Flag indicating if the remote user was authenticated.","required":true,"type":"string"},"attributes":{"description":"Attributes of Remote Test User Response.","items":{"description":"Remote attribute.","required":false,"additionalProperties":{"description":"Remote attribute value.","required":false,"xmlKeyName":"name","type":"string"},"id":"RemoteAttributes","type":"object"},"required":false,"id":"RemoteAttributesList","type":"array"},"authorized":{"description":"Flag indicating if the remote user was authorized (as Administrator, Monitor, etc).","required":true,"type":"string"}},"id":"RemoteTestUserResponse","type":"object","example":{"error_message":"","authenticated":true,"server_type":2,"permission_id":"","permission":"","role_id":0,"role":"","authorized":false,"server_ip":"10.38.8.112:1812","attributes":[{"25":"operatorClass"},{"25":"monitorClass"},{"25":"eventviewerClass"},{"17164":"unMappedRole"},{"17164":"monitorCascade"},{"17164":"eventviewerCascade"},{"17164":"dashboardCascade"},{"25":"DBAccess"},{"25":"dashboardClass"},{"17164":"AbC10~!@#$%^&*()_+{}|[]:;<>?\/.'z"},{"17164":"operatorCascade"},{"LOGIN_SERVER":"10.38.8.112:1812"},{"25":"adminClass1"},{"25":"unMappedClass"},{"25":"eventviewerClass"},{"17164":"adminCascade"}],"details":"Using 10.38.8.112:1812 - Unable to match a role."}},"authorization":"required"},"Test TACACS+ server":{"description":"Test the connection to a TACACS+ server.","parameters":{"server":{"required":true,"type":"string","description":"TACACS+ server identifier, example server=IP:PORT."}},"formats":["xml","json"],"httpmethod":"GET","path":"users\/tacacs\/test_server","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"RemoteTestServerResponse object.","properties":{"success":{"description":"Flag indicating if the remote server test was successful.","required":true,"type":"string"},"message":{"description":"Response message.","required":true,"type":"string"}},"id":"RemoteTestServerResponse","type":"object","example":{"message":"Connection attempt succeeded","success":true}},"authorization":"required"},"Test TACACS+ user":{"description":"Test a TACACS+ user.","parameters":{"password":{"required":true,"type":"string","description":"TACACS+ password."},"username":{"required":true,"type":"string","description":"TACACS+ username."}},"formats":["xml","json"],"request":{"description":"RemoteTestUserRequest object.","properties":{"password":{"description":"password.","required":true,"type":"string"},"username":{"description":"user name.","required":true,"type":"string"}},"id":"RemoteTestUserRequest","type":"object","example":{"username":"testusername","password":"testpassword"}},"httpmethod":"POST","path":"users\/tacacs\/test_user","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"RemoteTestUserResponse object.","properties":{"role_id":{"description":"Matched role ID.","required":true,"type":"number"},"error_message":{"description":"Error message.","required":true,"type":"string"},"permission":{"description":"Matched permission name.","required":true,"type":"string"},"server_type":{"description":"Indicates the type of the server being tested: RADIUS(2) or TACACS+(3).","required":true,"type":"number"},"role":{"description":"Matched role name.","required":true,"type":"string"},"details":{"description":"Remote user test details.","required":true,"type":"string"},"permission_id":{"description":"Matched permission ID.","required":true,"type":"string"},"server_ip":{"description":"Remote Server IP address.","required":true,"type":"string"},"authenticated":{"description":"Flag indicating if the remote user was authenticated.","required":true,"type":"string"},"attributes":{"description":"Attributes of Remote Test User Response.","items":{"description":"Remote attribute.","required":false,"additionalProperties":{"description":"Remote attribute value.","required":false,"xmlKeyName":"name","type":"string"},"id":"RemoteAttributes","type":"object"},"required":false,"id":"RemoteAttributesList","type":"array"},"authorized":{"description":"Flag indicating if the remote user was authorized (as Administrator, Monitor, etc).","required":true,"type":"string"}},"id":"RemoteTestUserResponse","type":"object","example":{"error_message":"","authenticated":true,"server_type":2,"permission_id":"","permission":"","role_id":0,"role":"","authorized":false,"server_ip":"10.38.8.112:1812","attributes":[{"25":"operatorClass"},{"25":"monitorClass"},{"25":"eventviewerClass"},{"17164":"unMappedRole"},{"17164":"monitorCascade"},{"17164":"eventviewerCascade"},{"17164":"dashboardCascade"},{"25":"DBAccess"},{"25":"dashboardClass"},{"17164":"AbC10~!@#$%^&*()_+{}|[]:;<>?\/.'z"},{"17164":"operatorCascade"},{"LOGIN_SERVER":"10.38.8.112:1812"},{"25":"adminClass1"},{"25":"unMappedClass"},{"25":"eventviewerClass"},{"17164":"adminCascade"}],"details":"Using 10.38.8.112:1812 - Unable to match a role."}},"authorization":"required"},"Test RADIUS server":{"description":"Test the connection to a RADIUS server.","parameters":{"server":{"required":true,"type":"string","description":"RADIUS server identifier, example server=IP:PORT."}},"formats":["xml","json"],"httpmethod":"GET","path":"users\/radius\/test_server","authorization_methods":["BASIC","COOKIE","OAUTH_2_0"],"response":{"description":"RemoteTestServerResponse object.","properties":{"success":{"description":"Flag indicating if the remote server test was successful.","required":true,"type":"string"},"message":{"description":"Response message.","required":true,"type":"string"}},"id":"RemoteTestServerResponse","type":"object","example":{"message":"Connection attempt succeeded","success":true}},"authorization":"required"}}}},"name":"gateway"}