POST /gateway-accounts/{id}/downtime-schedules

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

ID of the gateway account downtime schedule.

_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
startTime String Yes

Date and time when the gateway account scheduled downtime starts.

updatedTime String No

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

createdTime String No

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

status String No

Status of the gateway account downtime schedule.

Valid values:

  • "pending"
  • "ongoing"
  • "finished"
reason String No

Reason for the gateway account downtime schedule.

Valid values:

  • "daily-limit-reached"
  • "monthly-limit-reached"
  • "scheduled-maintenance"
endTime String Yes

Date and time when the gateway account scheduled downtime ends.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.