Skip to content

update_schedule

Overview

This resource can be used to get software update schedule information and to update software update schedule.

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • update_schedule : Operations related to update_schedule

Paths

Get operation for update_schedule

GET /update_schedule

Description

Use this operation to get software update schedule information.

Responses

HTTP Code Description Schema
200 API Successfully executed update_schedule_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • update_schedule

PUT operation for update_schedule

PUT /update_schedule

Description

Use this operation to update software update schedule of a site.

Parameters

Type Name Schema
Body body
optional
update_schedule_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added update_schedule_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • update_schedule

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

appliance_type

Appliance type: primary or secondary appliance

Type : enum (primary, secondary)

message

detailed messgae of command execution.

Type : string

repeat

Repeat next update.

Type : integer

repeat_unit

Repeat duration unit.

Type : enum (hours, days, weeks, months)

schedule_window

Update schedule window length in hours.

Type : integer

site_name

Site Name

Type : string

start_date_time

Update schedule start date, time.

Type : string

update_schedule

Name Schema
appliance_type
optional
appliance_type
repeat
optional
repeat
repeat_unit
optional
repeat_unit
schedule_window
optional
schedule_window
site_name
optional
site_name
start_date_time
optional
start_date_time

update_schedule_delete_success_schema

Name Schema
update_schedule
optional
update_schedule

update_schedule

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

update_schedule_post_success_schema

Name Schema
update_schedule
optional
update_schedule

update_schedule

Name Description Schema
message
optional
Example : "resource added succesfully" string

update_schedule_put_success_schema

Name Schema
update_schedule
optional
update_schedule

update_schedule

Name Description Schema
message
optional
Example : "resource modified succesfully" string

update_schedule_request_schema

Name Schema
update_schedule
optional
update_schedule

update_schedule_response_schema

Type : < update_schedule_response_schema > array

update_schedule_response_schema

Name Schema
appliance_type
optional
appliance_type
message
optional
message
repeat
optional
repeat
repeat_unit
optional
repeat_unit
schedule_window
optional
schedule_window
site_name
optional
site_name
start_date_time
optional
start_date_time