Skip to content

Software

Software update management.


Create

Endpoint

1
POST /software/create

Authorized User Role

1
admin

Request Body

Field Type Required Default
attachment object yes
cloudId string yes
description string yes
enable boolean true
image string
policy string
productId string yes
size number
version string yes
url string

Response

Field Type
accountId string
checksum string
cloudId string
description string
id string
enable boolean
image string
productId string
policy string
size number
url string
version string

Find

Endpoint

1
POST /software/find

Authorized User Role

1
user

Request Body

Field Type
productId string

Query String Options

Field Type
hidden boolean
filter string
limit number
next object
prev object
index string
where string
log boolean

Response

Paged response.

Field Type Notes
data array An array of metrics each containing an array of metric with the following properties.
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

An array of Software items.

Field Type
accountId string
checksum string
cloudId string
description string
id string
enable boolean
image string
productId string
policy string
size number
url string
version string

Get

Endpoint

1
POST /software/get

Authorized User Role

1
user

Request Body

Field Type Required
id string yes

Response

Field Type
accountId string
checksum string
cloudId string
description string
id string
enable boolean
image string
productId string
policy string
size number
url string
version string

Init

Endpoint

1
POST /software/init

Authorized User Role

1
admin

Request Body

A object.

Response

Field Type
accountId string
checksum string
cloudId string
description string
id string
enable boolean
image string
productId string
policy string
size number
url string
version string

Remove

Endpoint

1
POST /software/remove

Authorized User Role

1
admin

Request Body

Field Type Required
id string yes

Update

Endpoint

1
POST /software/update

Authorized User Role

1
admin

Request Body

Field Type Required
attachment object
cloudId string
description string
enable boolean
image string
id string yes
productId string
policy string
size number
version string
url string

Response

Field Type
accountId string
checksum string
cloudId string
description string
id string
enable boolean
image string
productId string
policy string
size number
url string
version string