Upgrade an Element (v2.0)
PUT/v2.0/api/tenants/:tenant_id/elements/:element_id/software/state
Upgrade an element.
Request
Path Parameters
tenant_id stringrequired
The tenant ID.
element_id stringrequired
The element ID.
- application/json
Body
download_interval integer
The software download interval. Valid download interval must be provided along with a valid download time.
id string
The ID.
image_id string
The element image ID.
interface_ids string[]
The software interface IDs.
scheduled_download string
The scheduled download.
scheduled_upgrade string
The scheduled upgrade.
upgrade_interval integer
The upgrade interval of the firmware. Valid upgrade interval must be provided along with a valid upgrade time.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
download_interval integer
The software download interval. Valid download interval must be provided along with a valid download time.
id string
The ID.
image_id string
The element image ID.
interface_ids string[]
The software interface IDs.
scheduled_download string
The scheduled download.
scheduled_upgrade string
The scheduled upgrade.
upgrade_interval integer
The upgrade interval of the firmware. Valid upgrade interval must be provided along with a valid upgrade time.
{
"download_interval": 0,
"id": "string",
"image_id": "string",
"interface_ids": [
"string"
],
"scheduled_download": "string",
"scheduled_upgrade": "string",
"upgrade_interval": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
code string
The error code.
message string
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "SOFTWARE_CONFIG_INVALID_SCHEDULING"
},
{
"code": "SOFTWARE_CONFIG_SCHEDULED_UPGRADE_NOT_SUPPORTED"
},
{
"code": "SOFTWARE_CONFIG_INVALID_DOWNLOAD_INTERVAL"
},
{
"code": "SOFTWARE_CONFIG_INVALID_UPGRADE_INTERVAL"
},
{
"code": "SOFTWARE_CONFIG_INVALID_DOWNLOAD_TIME"
},
{
"code": "SOFTWARE_CONFIG_INVALID_UPGRADE_TIME"
},
{
"code": "SOFTWARE_CONFIG_INCOMPATIBLE_SCHEDULES"
},
{
"code": "SOFTWARE_CONFIG_INVALID_INTERFACES"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
}
]
}
}
Loading...