Retrieve a gateway account downtime schedule

Retrieves a gateway account downtime schedule with a specified ID.

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

Resource identifier string.

downtimeId
required
string

ID of the gateway account downtime.

Responses
200

Gateway downtime schedule retrieved.

Response Schema: application/json
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.

404

Resource not found.

get/gateway-accounts/{id}/downtime-schedules/{downtimeId}
Request samples
const downtimeSchedule = await api.gatewayAccounts.getDowntimeSchedule({id: 'foobar-001', downtimeScheduleId: 'foobar-202'});
console.log(downtimeSchedule.fields.reason);
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}