Create Maintenance Window

Create Maintenance Window

Create a maintenance window

Request
URI
POST
https://{api_host}/api/v2/maintenancewindow
COPY
Request Body
MaintenanceWindow of type(s) application/json
Optional 
{
    "id": "string",
    "reason": "string",
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "title": "string",
    "customerId": "string",
    "creatorId": "string",
    "updaterId": "string",
    "startTimeInSeconds": 0,
    "endTimeInSeconds": 0,
    "relevantCustomerTags": [
        "string"
    ],
    "relevantHostNames": [
        "string"
    ],
    "relevantHostTags": [
        "string"
    ],
    "relevantCustomerTagsAnded": false,
    "relevantHostTagsAnded": false,
    "hostTagGroupHostNamesGroupAnded": false,
    "pointTagFilter": "string",
    "pointTagFilterAnded": false,
    "eventName": "string",
    "targets": [
        "string"
    ],
    "sortAttr": 0,
    "runningState": "string"
}
string
id
Optional

id

string
reason
Required

The purpose of this maintenance window

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

string
title
Required

Title of this maintenance window

string
customerId
Optional

customerId

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

integer As int64 As int64
startTimeInSeconds
Required

The time in epoch seconds when this maintenance window will start

integer As int64 As int64
endTimeInSeconds
Required

The time in epoch seconds when this maintenance window will end

array of string
relevantCustomerTags
Required

List of alert tags whose matching alerts will be put into maintenance because of this maintenance window

array of string
relevantHostNames
Optional

List of source/host names that will be put into maintenance because of this maintenance window

array of string
relevantHostTags
Optional

List of source/host tags whose matching sources/hosts will be put into maintenance because of this maintenance window

boolean
relevantCustomerTagsAnded
Optional

Whether to AND customer tags listed in relevantCustomerTags. If true, a customer must contain all tags in order for the maintenance window to apply. If false, the tags are OR'ed, and a customer must contain one of the tags. Default: false

boolean
relevantHostTagsAnded
Optional

Whether to AND source/host tags listed in relevantHostTags. If true, a source/host must contain all tags in order for the maintenance window to apply. If false, the tags are OR'ed, and a source/host must contain one of the tags. Default: false

boolean
hostTagGroupHostNamesGroupAnded
Optional

If true, a source/host must be in 'relevantHostNames' and have tags matching the specification formed by 'relevantHostTags' and 'relevantHostTagsAnded' in order for this maintenance window to apply. If false, a source/host must either be in 'relevantHostNames' or match 'relevantHostTags' and 'relevantHostTagsAnded'. Default: false

string
pointTagFilter
Optional

Query that filters on point tags of timeseries scanned by alert.

boolean
pointTagFilterAnded
Optional

Whether to AND point tags filter listed in pointTagFilter. If true, a timeseries must contain the point tags along with other filters in order for the maintenance window to apply.If false, the tags are OR'ed, the customer must contain one of the tags. Default: false

string
eventName
Optional

The name of an event associated with the creation/update of this maintenance window

array of string
targets
Optional

List of targets to notify, overriding the alert's targets.

integer As int32 As int32
sortAttr
Optional

Numeric value used in default sorting

string
runningState
Optional

runningState

Possible values are : ONGOING, PENDING, ENDED,
Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerMaintenanceWindow of type(s) application/json 
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "id": "string",
        "reason": "string",
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "title": "string",
        "customerId": "string",
        "creatorId": "string",
        "updaterId": "string",
        "startTimeInSeconds": 0,
        "endTimeInSeconds": 0,
        "relevantCustomerTags": [
            "string"
        ],
        "relevantHostNames": [
            "string"
        ],
        "relevantHostTags": [
            "string"
        ],
        "relevantCustomerTagsAnded": false,
        "relevantHostTagsAnded": false,
        "hostTagGroupHostNamesGroupAnded": false,
        "pointTagFilter": "string",
        "pointTagFilterAnded": false,
        "eventName": "string",
        "targets": [
            "string"
        ],
        "sortAttr": 0,
        "runningState": "string"
    }
}
ResponseStatus
status
Required

status

MaintenanceWindow
response
Optional

response


On This Page
Maintenance Window Operations
POST
Create Maintenance Window
DELETE
Delete Maintenance Window
GET
Get All Maintenance Window
GET
Get Maintenance Window
PUT
Update Maintenance Window