Maintenance Windows

List maintenance windows.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Query parameters
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50
Responses
200

the maintenance window object

application/json
get
/maintenance-windows
200

the maintenance window object

Create a new maintenance window.

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Body
timezonestring · enumOptionalPossible values:
startstring · date-timeOptional
endstring · date-timeOptional
summarystringOptional
descriptionstringOptional
createdBystringRead-onlyOptional
Responses
200

The URI of the maintenance window will be included in the location header and the maintenance window will be included in the body.

application/json
post
/maintenance-windows
200

The URI of the maintenance window will be included in the location header and the maintenance window will be included in the body.

Get the maintenance window with specified id.

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Responses
200

the maintenance window object

application/json
get
/maintenance-windows/{id}
200

the maintenance window object

Update an existing maintenance window.

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Body
timezonestring · enumOptionalPossible values:
startstring · date-timeOptional
endstring · date-timeOptional
summarystringOptional
descriptionstringOptional
createdBystringRead-onlyOptional
Responses
200

the updated maintenance window object

application/json
put
/maintenance-windows/{id}
200

the updated maintenance window object

Delete the specified maintenance window.

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
idnumberRequired

entity ID

Responses
delete
/maintenance-windows/{id}
204

if deletion was successful

No content

Last updated

Was this helpful?