Schedules

Get bandwidth schedule by id

Get bandwidth schedule

get/schedules/{id}

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

Bandwidth schedule id

Response

Successful response

idnumber required

Bandwidth schedule id

namestring required

Bandwidth schedule name

descriptionstring required

Bandwidth schedule description

is_globalboolean required

Determines if the bandwidth schedule is default

time_blocksnumber required

Bandwidth schedule's rules indexes. First level array contains arrays of indexes per day of week (starting from Monday). Second level array contains rule indexes for each hour (0-23). Scheduler runs in a local Agents time zone

rulesobject required

Bandwidth schedule's rules descriptions.

rules.indexnumber required

Rule index

rules.up_speednumber required

Rule sending limit (KBps). Unlimited value is -1

rules.down_speednumber required

Rule receiving limit (KBps). Unlimited value is -1

Changes

No recorded changes to this operation across all 1 revision of this API.