/
List gateway account down...

List gateway account downtime schedules

Request

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

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}/downtime-schedules?limit=0&offset=0&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of gateway account downtime schedules retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the gateway account downtime schedule.

Example:"gw_dwn_0YVCXRK9TKCC6AMAPFB9M4RXDP"
statusstringread-only

Status of the gateway account downtime schedule.

Enum:"pending""ongoing""finished"
reasonstringread-only

Reason for the gateway account downtime schedule.

Enum:"scheduled-maintenance""daily-limit-reached""monthly-limit-reached""gateway-unreachable"
startTimestring, (date-time)required

Date and time when the gateway account scheduled downtime starts.

endTimestring, (date-time)required

Date and time when the gateway account scheduled downtime ends.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "gw_dwn_0YVCXRK9TKCC6AMAPFB9M4RXDP",
    "status": "pending",
    "reason": "scheduled-maintenance",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]