REST endpoints: Software updates and license
These endpoints mirror the CLI commands described in Software updates, License. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.
Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.
PUT /license/upload
Upload a new license.
CLI command: license upload
Body fields (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
FileToUpload |
string | Yes | The license file to upload. |
GET /license/view
View license details.
CLI command: license view
This endpoint takes no parameters.
Response: an object of type LicenseDataV2 in Result.
PUT /software_updates/installation/install
Install a downloaded or uploaded software update on a node.
CLI command: software_updates installation install
Body fields (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
Node |
string | Yes | The node to install the version on. |
Version |
string | Yes | The version to install. |
Force |
boolean | No | Skip the confirmation prompt. |
DELETE /software_updates/uploads/delete
Delete the uploaded software update.
CLI command: software_updates uploads delete
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
node |
string | Yes | The node to delete the uploaded version from. |
GET /software_updates/uploads/list
List the uploaded software update.
CLI command: software_updates uploads list
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
node |
string | No | Filter by node name. |
Response: a list of VersionElement objects in Result.VersionElement, each with: BuildNumber (string), Version (string), Node (string), Status (string), DownloadProgressInPercentage (number), ExtractionProgressInPercentage (number), FailureMessage (string), Description (string), ReleaseDate (string).
POST /software_updates/uploads/upload
Upload a software update, replacing any previous upload.
CLI command: software_updates uploads upload
Body fields (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
FileToUpload |
string | Yes | The software update to upload. |
See also: Requests and responses - Authentication - Examples
No comments to display
No comments to display