APaptible
MaintenanceWindows

show maintenance_window

Changed on

Returns the details of a specific maintenance window by ID.

get/maintenance_windows/{id}

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

idinteger required

id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Response

successful

idinteger required
account_idinteger
day_of_weekinteger
start_time_utcstring

Start of the window, in UTC, as HH:MM (e.g. "22:00")

duration_hoursinteger
enabledboolean
created_atstring dateTime
updated_atstring dateTime

Changes