{ "restSchemaVersion": "1.0", "errors": [ { "error_id": "PARTIAL_CONTENT", "description": "Operation was partially successfull.", "http_status": "206" }, { "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": "INTERNAL_ERROR", "description": "Internal error.", "http_status": "500" } ], "name": "mgmt.system_update", "title": "Software Update API.", "version": "1.0", "schemas": [], "defaultAuthorization": "required", "servicePath": "/api/mgmt.system_update/1.0", "resources": { "Images": { "methods": { "Upload ISO": { "description": "The .iso image needs to be passed as a binary object using form-data where key = 'file' and value = 'file object' ", "httpmethod": "PUT", "path": "images/upload", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Fetch ISO": { "description": "Fetches ISO from a specified url.", "formats": [ "json" ], "httpmethod": "PUT", "path": "images/fetch", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "request": { "description": "Fetches .iso file from specified url to the Riverbed SteelCentral device.", "properties": { "url": { "description": "URL from where ISO needs to be fetched to Riverbed SteelCentral device.", "required": true, "type": "string" } }, "id": "FetchImage", "type": "object", "example": { "url": "http://xxxx:xxxx/install-10.21-xxx-192.iso" } }, "authorization": "required" }, "Get ISO Image Details": { "description": "Provides Information about ISO Images Uploading / Uploaded.", "formats": [ "json" ], "httpmethod": "GET", "path": "images", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Information about ISO Images Uploading / Uploaded.", "items": { "description": "ISO image details .", "required": false, "properties": { "id": { "description": "A unique identifier for the ISO image.", "required": true, "type": "string" }, "filename": { "description": "Name of the ISO image.", "required": true, "type": "string" }, "progress": { "description": "The progress of the current upload/fetch operation.", "required": true, "type": "string" }, "state": { "description": "The state of the ISO image getting uploaded.", "required": true, "type": "string", "enum": [ "Uploaded", "Uploading", "Upload Error" ] }, "checksum": { "description": "The SHA-256 checksum of the uploaded ISO image.", "required": true, "type": "string" }, "version": { "description": "The version of the uploading/uploaded ISO image.", "required": true, "type": "string" } }, "id": "Image", "type": "object" }, "id": "Images", "type": "array", "example": [ { "id": 1, "filename": "install-10.22-xxxx-192.iso", "progress": "100.0%", "state": "Uploaded", "checksum": "94b58c6a41f18605705a43c23d4859991f91303337bdc412f9e53d2ca9758484", "version": "10.22" } ] }, "authorization": "required" }, "Get ISO Image Details using id": { "description": "Provides Information about a particular ISO Image uploading / uploaded.", "formats": [ "json" ], "httpmethod": "GET", "path": "images/items/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Information about a particular ISO Image Uploading / Uploaded.", "properties": { "id": { "description": "A unique identifier for the ISO image.", "required": true, "type": "string" }, "filename": { "description": "Name of the ISO image.", "required": true, "type": "string" }, "progress": { "description": "The progress of the current upload/fetch operation.", "required": true, "type": "string" }, "state": { "description": "The state of the ISO image getting uploaded.", "required": true, "type": "string", "enum": [ "Uploaded", "Uploading", "Upload Error" ] }, "checksum": { "description": "The SHA-256 checksum of the uploaded ISO image.", "required": true, "type": "string" }, "version": { "description": "The version of the uploading/uploaded ISO image.", "required": true, "type": "string" } }, "id": "Image", "type": "object", "example": { "id": 1, "filename": "install-10.22-xxxx-192.iso", "progress": "51%", "state": "Uploading", "checksum": "94b58c6a41f18605705a43c23d4859991f91303337bdc412f9e53d2ca9758484", "version": "10.22" } }, "authorization": "required" }, "Delete ISO Image": { "description": "Removes the ISO and clears Information about the same.", "httpmethod": "DELETE", "path": "images/items/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Update": { "methods": { "Update Status": { "description": "Get the status of Software Update.", "formats": [ "json" ], "httpmethod": "GET", "path": "update", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Software Update Current Status.", "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 Riverbed SteelCentral version.", "required": true, "type": "string" }, "Update To Version": { "description": "Displays Target version to which Riverbed SteelCentral needs to be updated to.", "required": true, "type": "string" } }, "id": "UpdateStatus", "type": "object", "example": { "State": "neutral", "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": "Initialize the Riverbed SteelCentral. The operation is synchronous.", "httpmethod": "POST", "path": "update/init", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Uninitialize": { "description": "Uninitialize the Riverbed SteelCentral. The operation is synchronous.", "httpmethod": "POST", "path": "update/reset", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Start Update": { "description": "Start the software update on the Riverbed SteelCentral. The operation is asynchronous", "httpmethod": "POST", "path": "update/start", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } } }, "description": "

Overview

\n\n

\nThe documentation pages in this section describe\nthe RESTful APIs included with Riverbed SteelCentral 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 how\niso image can be uploaded, how to track progress for iso upload, removing iso and all the software update related operations.\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" }