{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "BAD_REQUEST", "description": "Invalid argument.", "http_status": "400" }, { "error_id": "AUTH_REQUIRED", "description": "Authentication required.", "http_status": "401" }, { "error_id": "AUTH_INVALID_CREDENTIALS", "description": "Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.", "http_status": "401" }, { "error_id": "HTTP_INVALID_METHOD", "description": "Requested method is not available for this resource.", "http_status": "405" } ], "name": "mgmt.common_update", "title": "Batch Flow Gateway Update API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.common_update/1.0", "resources": { "Images": { "methods": { "Upload ISO": { "description": "Uploads ISO image to all connected FlowGateways. Prior to this api, user should upload ISO manually on relevant NetProfiler using /api/api/mgmt.system_update/1.0/ upload or fetch api.", "httpmethod": "PUT", "path": "images/upload", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Update": { "methods": { "Update Status": { "description": "Gets the current status of Software Update for all connected FlowGateways.", "formats": [ "json" ], "httpmethod": "GET", "path": "update", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Software Update Current Status on all connected FlowGateways.", "items": { "description": "List of Software Update Status for all connected FlowGateways.", "required": false, "properties": { "State": { "description": "The state of the update.", "enum": [ "neutral", "initializing", "initialized", "running", "failed_graceful", "failed_critical" ], "required": true, "type": "string" }, "Internal State description": { "description": "Displays Internal State Description only at the time of failure during software update.", "required": false, "type": "string" }, "State description": { "description": "Displays State Description only at the time of failure during software update.", "required": false, "type": "string" }, "Current Version": { "description": "Displays Current FlowGateway version.", "required": true, "type": "string" }, "Update To Version": { "description": "Displays Target version to which FlowGateway needs to be updated to.", "required": true, "type": "string" } }, "id": "UpdateStatus", "type": "object" }, "id": "UpdatesStatus", "type": "array", "example": [ { "1.2.3.4": { "State": "initializing", "Internal State Description": "Visible only during State = failed_graceful or failed_critical", "State Description": "Visible only during State = failed_graceful or failed_critical", "Current Version": "10.22", "Update To Version": "10.23" } }, { "1.2.3.5": { "State": "initialized", "Internal State Description": "Visible only during State = failed_graceful or failed_critical", "State Description": "Visible only during State = failed_graceful or failed_critical", "Current Version": "10.22", "Update To Version": "10.23" } } ] }, "authorization": "required" }, "Initialize": { "description": "Initializes all the connected FlowGateway systems.", "httpmethod": "POST", "path": "update/init", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Results of initialization operation for all connected FlowGateways.", "items": { "description": "Displays FlowGateway IP address along with Success or Failure for init operation.", "required": true, "type": "string" }, "id": "InitResult", "type": "array", "example": [ "10.1.x.x - Operation Failed", "10.2.x.x - Operation Successfull" ] }, "authorization": "required" }, "Start Update": { "description": "Start the software update on all the connected FlowGateways. The operation is asynchronous. This operation is asynchronous. Please monitor the final status of Software Update operation using /api/mgmt.common_update/1.0/update api", "httpmethod": "POST", "path": "update/start", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Results of initialization operation for all connected FlowGateways.", "items": { "description": "Displays FlowGateway IP address along with Success or Failure for start update operation.", "required": true, "type": "string" }, "id": "StartUpdateResult", "type": "array", "example": [ "10.1.x.x - Operation Failed", "10.2.x.x - Operation Successfull" ] }, "authorization": "required" } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with Riverbed Netprofiler Product. 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 how\n from a NetProfiler software update can be performed on all the connected FlowGateways to it, how to distribute .iso to all the connected FlowGateways.\n

\n\n

\nThe following operations can be performed via the API:\n

\n\n\n

\nDetails about REST resources can be found in the Resources\nsection. This overview continues with how to run these API's.\n

\n\n

Authentication

\n\n

\nAll REST requests must be authenticated. The Authentication\nsection of the Common API describes which authentication methods\nare presently supported.\n

\n\n" }