Upgrade Machine Software (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/machines/:machine_id/software/:software_id

Upgrade the machine software.

Request

Path Parameters

tenant_id stringrequired

The ID of the tenant.

machine_id stringrequired

The ID of the device.

software_id stringrequired

The ID of the device software.

application/json

Body

id string

The device software ID.

scheduled_upgrade string

The devices for which software upgrades have been scheduled. The list will display a temporary download completed state and then the scheduled upgrade.

tenant_id stringrequired

ID of the tenant.

upgrade_interval integer

The upgrade interval time limit until an upgrade attempt is performed.

upgrade_version stringrequired

The software version for the upgrade.

Responses

200

Successful Operation

application/json

Schema

Schema

id string

The device software ID.

scheduled_upgrade string

The devices for which software upgrades have been scheduled. The list will display a temporary download completed state and then the scheduled upgrade.

tenant_id stringrequired

ID of the tenant.

upgrade_interval integer

The upgrade interval time limit until an upgrade attempt is performed.

upgrade_version stringrequired

The software version for the upgrade.

Example (from schema)

{
  "id": "string",
  "scheduled_upgrade": "string",
  "tenant_id": "string",
  "upgrade_interval": 0,
  "upgrade_version": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "MACHINE_UNKNOWN"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "MACHINE_SOFTWARE_CONFIG_VERSION_NOT_FOUND"
      },
      {
        "code": "MACHINE_SOFTWARE_CONFIG_ELEMENT_CLAIMED"
      },
      {
        "code": "MACHINE_SOFTWARE_CONFIG_VERSION_NOT_ALLOCATED"
      },
      {
        "code": "MACHINE_SOFTWARE_CONFIG_VERSION_ALREADY_PRESENT"
      }
    ]
  }
}

Loading...