List gateway account downtime schedules

Retrieves a list of downtime schedules for a gateway account with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of gateway account downtime schedules retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
startTime
required
string <date-time>

Date and time when the gateway account scheduled downtime starts.

endTime
required
string <date-time>

Date and time when the gateway account scheduled downtime ends.

id
string <= 50 characters

ID of the gateway account downtime schedule.

status
string

Status of the gateway account downtime schedule.

Enum: "pending" "ongoing" "finished"
reason
string

Reason for the gateway account downtime schedule.

Enum: "scheduled-maintenance" "daily-limit-reached" "monthly-limit-reached"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/gateway-accounts/{id}/downtime-schedules
Request samples
// all parameters are optional except for the `id`
const firstCollection = await api.gatewayAccounts.getAllDowntimeSchedules({id: 'my-gateway'});

// alternatively you can specify one or more of them
const params = {id: 'my-gateway', limit: 20, offset: 100};
const secondCollection = await api.gatewayAccounts.getAllDowntimeSchedules(params);

// access the collection items, each item is a Member
secondCollection.items
    .forEach(gatewayAccount => console.log(gatewayAccount.fields.reason));
Response samples
application/json
[
  • {
    }
]