Update a gateway account downtime schedule

Request

Updates a gateway account downtime schedule with a specified ID.

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

ID of the resource.

downtimeIdstringrequired

ID of the gateway account downtime.

Bodyapplication/jsonrequired

Gateway Account downtime schedule resource.

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.

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/gateway-accounts/{id}/downtime-schedules/{downtimeId}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }'

Responses

Gateway account downtime schedule updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
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"
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": [ {} ] }