Create a gateway account downtime schedule

Creates a downtime schedule for a gateway account with a specified ID.

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

Resource identifier string.

Request Body schema: application/json

Gateway Account downtime schedule resource.

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.

Responses
201

Gateway account downtime schedule created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
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.

409

Conflict.

422

Invalid data sent.

post/gateway-accounts/{id}/downtime-schedules
Request samples
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}
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": [
    ]
}