Upgrade an Element (v2.0)

PUT 
/sdwan/v2.0/api/elements/:element_id/software/state

Upgrade an element.

Request

Path Parameters

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

Successful Operation

application/json

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.

Example (from schema)

{
  "download_interval": 0,
  "id": "string",
  "image_id": "string",
  "interface_ids": [
    "string"
  ],
  "scheduled_download": "string",
  "scheduled_upgrade": "string",
  "upgrade_interval": 0
}

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": "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...