Software
Software update management.
Create
Create a software update.
Endpoint
HTTP
POST /software/createAuthorized User Role
adminRequest Body
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
| attachment | object | yes | Uploaded software image. | |
| cloudId | string | yes | Cloud ID. | |
| description | string | yes | Software description. | |
| enable | boolean | true | Enable. | |
| image | string | Image name. | ||
| limit | number | Number of devices to update. | ||
| percentage | number | Percentage of devices to update. | ||
| period | number | Rate period in seconds. | ||
| policy | string | Distribution policy expression. | ||
| productId | string | yes | Product ID. | |
| rate | number | Number of updates per period. | ||
| size | number | Size of the software image. | ||
| version | string | yes | Software version. |
Response
Software Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| created | date | Software creation date. |
| checksum | string | Software checksum. |
| cloudId | string | Owning cloud ID. |
| description | string | Software description. |
| id | string | Software ID. |
| enable | boolean | Software enabled. |
| limit | number | Count of devices to update. |
| image | string | Software image. |
| percentage | number | Perentage of devices to update. |
| period | number | Rate period in seconds. |
| productId | string | Owning product ID. |
| policy | string | Software distribution policy expression. |
| rate | number | Number of updates per period. |
| size | number | Software size. |
| version | string | Software version. |
Find
Get a list of software updates.
Endpoint
HTTP
POST /software/findAuthorized User Role
userRequest Body
| Field | Type | Notes |
|---|---|---|
| productId | string | Product ID. |
Query String Options
| Field | Type | Default | Notes |
|---|---|---|---|
| index | string | Index name: primary or gs1. | |
| limit | number | Limit number of results. | |
| next | object | Token for next page. | |
| prev | object | Token for previous page. |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of Software records. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Software
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| created | date | Software creation date. |
| checksum | string | Software checksum. |
| cloudId | string | Owning cloud ID. |
| description | string | Software description. |
| id | string | Software ID. |
| enable | boolean | Software enabled. |
| limit | number | Count of devices to update. |
| image | string | Software image. |
| percentage | number | Perentage of devices to update. |
| period | number | Rate period in seconds. |
| productId | string | Owning product ID. |
| policy | string | Software distribution policy expression. |
| rate | number | Number of updates per period. |
| size | number | Software size. |
| version | string | Software version. |
Get
Get a software update by ID.
Endpoint
HTTP
POST /software/getAuthorized User Role
userRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | Software ID. |
Response
Software Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| created | date | Software creation date. |
| checksum | string | Software checksum. |
| cloudId | string | Owning cloud ID. |
| description | string | Software description. |
| id | string | Software ID. |
| enable | boolean | Software enabled. |
| limit | number | Count of devices to update. |
| image | string | Software image. |
| percentage | number | Perentage of devices to update. |
| period | number | Rate period in seconds. |
| productId | string | Owning product ID. |
| policy | string | Software distribution policy expression. |
| rate | number | Number of updates per period. |
| size | number | Software size. |
| version | string | Software version. |
Remove
Remove a software update.
Endpoint
HTTP
POST /software/removeAuthorized User Role
adminRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| id | string | yes | Software ID. |
Update
Update a software update.
Endpoint
HTTP
POST /software/updateAuthorized User Role
adminRequest Body
| Field | Type | Required | Notes |
|---|---|---|---|
| attachment | object | Uploaded software image. | |
| cloudId | string | Cloud ID. | |
| description | string | Software description. | |
| enable | boolean | Enable. | |
| limit | number | Number of devices to update. | |
| image | string | Image name. | |
| id | string | yes | Software ID. |
| percentage | number | Percentage of devices to update. | |
| period | number | Rate period in seconds. | |
| productId | string | Product ID. | |
| policy | string | Distribution policy expression. | |
| rate | number | Number of updates per period. | |
| size | number | Size of the software image. | |
| version | string | Software version. |
Response
Software Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| created | date | Software creation date. |
| checksum | string | Software checksum. |
| cloudId | string | Owning cloud ID. |
| description | string | Software description. |
| id | string | Software ID. |
| enable | boolean | Software enabled. |
| limit | number | Count of devices to update. |
| image | string | Software image. |
| percentage | number | Perentage of devices to update. |
| period | number | Rate period in seconds. |
| productId | string | Owning product ID. |
| policy | string | Software distribution policy expression. |
| rate | number | Number of updates per period. |
| size | number | Software size. |
| version | string | Software version. |