Sign in
maintenance-window

Create a maintenance window.

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/maintenance_window</span></div>

Refer to Spaces for more information.

[Required authorization] Route required privileges: write-maintenance-window.

post/api/maintenance_window

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

enabledboolean

Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.

titlestring required

The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.

Response

Indicates a successful call.

created_atstring required

The date and time when the maintenance window was created.

created_bystring nullable

The identifier for the user that created the maintenance window.

enabledboolean required

Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.

idstring required

The identifier for the maintenance window.

status'running' | 'upcoming' | 'finished' | 'archived' | 'disabled' required

The current status of the maintenance window.

titlestring required

The name of the maintenance window.

updated_atstring required

The date and time when the maintenance window was last updated.

updated_bystring nullable

The identifier for the user that last updated this maintenance window.

Changes

Changed in 2 of the 176 revisions of this API.61

  • 97699059d3b31See the full diff
    • ○

      the //// request property's min was decreased from 1.00 to -1.00

      request-property-min-decreased

  • 43068c4185f96See the full diff
    • ●

      the // request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the /// request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the /// request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the //// request property's maxLength was set to 10

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 100

      request-property-max-length-set

    • ●

      the // request property's maxLength was set to 64

      request-property-max-length-set

Of the 176 revisions, 20 have no diff computed.