topic Re: Creating maintenance window using setting API in Alerting

Creating maintenance window using setting API

Naveen — Mon, 29 May 2023 13:35:28 GMT

Hi,

I am trying to create a maintenance window using settings API, but getting an error, could anyone please help?

Body:

[ { "schemaId": "builtin:alerting.maintenance-window", "displayName": "Maintenance windows", "description": "Maintenance windows are typically planned, recurring periods of system downtime during which your DevOps team can perform preventative maintenance and system upgrades outside of peak traffic hours.", "scope": "environment", "value": { "enabled": true, "generalProperties": { "name": "Example Window", "description": "An example Maintenance window", "maintenanceType": "UNPLANNED", "suppression": "DONT_DETECT_PROBLEMS", "disableSyntheticMonitorExecution": true }, "schedule": { "scheduleType": "ONCE", "OnceRecurrence": { "startTime": "13:45:00", "endTime": "14:45:00", "timeZone": "Europe/Vienna" } } } } ]

Error:

"code": 400, "error": { "code": 400, "message": "Validation failed for 2 Validators.", "constraintViolations": [ { "path": "builtin:alerting.maintenance-window/0/schedule/onceRecurrence", "message": "Given property 'onceRecurrence' with value: 'null' does not comply with required NonNull of schema", "parameterLocation": "PAYLOAD_BODY", "location": null }, { "path": "builtin:alerting.maintenance-window/0/schedule/OnceRecurrence", "message": "Given property 'OnceRecurrence' with value: '{startTime=13:45:00, endTime=14:45:00, timeZone=Europe/Vienna}' was not found in the schema", "parameterLocation": "PAYLOAD_BODY", "location": null } ] }

Re: How to create maintenance window using setting API?

mgome — Wed, 24 May 2023 16:49:47 GMT

You can generate a sample payload by creating a maintenance window in the console and using the API option under the "..." button in the upper right corner of the maintenance window configuration. Open the "Add as new value" section and copy the result, which has the JSON payload as part of the curl command.

When I dumped the JSON for one of my maintenance windows, the onceRecurrence looked like this:

"onceRecurrence": {
"startTime": "2020-09-26T22:50:00",
"endTime": "2020-09-27T00:00:00",
"timeZone": "America/Los_Angeles"
}

You're missing the date in your start and end times.

The local_date_time is of type java.time.LocalDateTime

https://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html

Re: How to create maintenance window using setting API?

ChadTurner — Wed, 24 May 2023 17:22:44 GMT

I highly recommend making one via the UI, then do an API pull to grab the json for that Maintenance Window. Then once you do that you can break it down and templatize the MW. That's how we did it and inserted that Json into the CICD Pipeline.

Re: How to create maintenance window using setting API?

Naveen — Thu, 25 May 2023 13:43:20 GMT

Thanks @ChadTurner and @mgome I have tried the method suggested by you but getting below error in the request
I am using powershell to get time and invoking API.

Invoke-RestMethod : [{"code":400,"error":{"code":400,"message":"Validation failed for 6 Validators.","constraintViolations":[{" path":"builtin:alerting.maintenance-window/0/schedule/onceRecurrence/startTime","message":"Given property 'startTime' with value: '2023-05-25 11.35.09' violates the following constraint: Must be of type local_date_time.","parameterLocation":"PAYLOAD_ BODY","location":null},{"path":"builtin:alerting.maintenance-window/0/schedule/onceRecurrence/endTime","message":"Given property 'endTime' with value: '2023-05-25 12.35.09' violates the following constraint: Must be of type local_date_time.","para meterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin:alerting.maintenance-window/0/generalProperties/disableSyntheti cMonitorExecution","message":"Given property 'disableSyntheticMonitorExecution' with value: 'true' violates the following constraint: Must be of type boolean.","parameterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin:alerting.maintenance -window/0/filters/0/entityId","message":"Given property 'entityId' with value: 'null' violates the following constraint: Please use a format of TYPE-ID.","parameterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin:alerting.maintenance-wind ow/0/filters/0/entityId","message":"Given property 'entityId' with value: 'null' violates the following constraint: Invalid entity id..","parameterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin:alerting.maintenance-window/0/enabled","messa

Could you please help, I have tried putting up different time format like 2023-05-25T15.30.54 or 1685009069

Re: How to create maintenance window using setting API?

Naveen — Thu, 25 May 2023 15:28:23 GMT

Thanks @ChadTurner and @mgome I have tried posting it using the powershell but unable to format the starttime and endtime, could you please let me know what time format is it.

I have tried ([DateTimeOffset]$localTime).ToUnixTimeSeconds() or $localTime.ToString("yyyy-MM-ddTHH:mm:ss") but it's throwing an error.

Re: How to create maintenance window using setting API?

mgome — Thu, 25 May 2023 16:03:17 GMT

The proper key is "onceRecurrence". You have "OnceRecurrence" with a capital "O" in your payload.

Re: How to create maintenance window using setting API?

Naveen — Fri, 26 May 2023 08:10:24 GMT

Hey @mgome still the same error

Invoke-RestMethod : [{"code":400,"error":{"code":400,"message":"Validation failed for 6
Validators.","constraintViolations":[{"path":"builtin:alerting.maintenance-window/0/schedule/onceRecurrence","message":"Given
property 'onceRecurrence' with value: 'null' does not comply with required NonNull of schema","parameterLocation":"PAYLOAD_BODY
","location":null},{"path":"builtin:alerting.maintenance-window/0/schedule/OnceRecurrence","message":"Given property
'OnceRecurrence' with value: '{endTime=2023-05-26T14.39.44, timeZone=Europe/Copenhagen, startTime=2023-05-26T13.39.44}' was
not found in the schema","parameterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin:alerting.maintenance-window/0/gen
eralProperties/disableSyntheticMonitorExecution","message":"Given property 'disableSyntheticMonitorExecution' with value:
'true' violates the following constraint: Must be of type boolean.","parameterLocation":"PAYLOAD_BODY","location":null},{"path"
:"builtin:alerting.maintenance-window/0/filters/0/entityId","message":"Given property 'entityId' with value: 'null' violates
the following constraint: Please use a format of TYPE-ID.","parameterLocation":"PAYLOAD_BODY","location":null},{"path":"builtin
:alerting.maintenance-window/0/filters/0/entityId","message":"Given property 'entityId' with value: 'null' violates the

Re: Creating maintenance window using setting API

ChadTurner — Fri, 26 May 2023 12:02:40 GMT

@Naveen there are several Syntax errors in your Json. please use the following to post your MZs via the API. You will need to update the start/end time tho.

[ { "scope": "environment", "schemaId": "builtin:alerting.maintenance-window", "schemaVersion": "2.14.2", "value": { "enabled": true, "generalProperties": { "name": "Maintenance windows", "description": "Maintenance windows are typically planned, recurring periods of system downtime during which your DevOps team can perform preventative maintenance and system upgrades outside of peak traffic hours.", "maintenanceType": "UNPLANNED", "suppression": "DONT_DETECT_PROBLEMS", "disableSyntheticMonitorExecution": true }, "schedule": { "scheduleType": "ONCE", "onceRecurrence": { "startTime": "2023-07-25T13:45:00", "endTime": "2023-08-22T14:45:00", "timeZone": "Europe/Vienna" } }, "filters": [] } } ]

So what were you missing?

1 - Schema Version was missing

2 - Conflicting names and descriptions

3 - No Date with your time stamp for both start and end

4 - Missing the filters segment

5 - Bracket/Braces were not correct.

Please save this as a gold template for you to leverage with posting of MWs via the API

Re: Creating maintenance window using setting API

gabrielsantos — Thu, 26 Oct 2023 13:35:01 GMT

Hello,

I've tried to use this code to create a MW from Servicenow via REST and I am getting the following error:

*** Script: {"error":{"code":400,"message":"Could not map JSON at '' near line 1 column 1"}}

My code is the following:

I dont understand why this is not being able to parse the JSON.

Thanks in advance.

Gabriel

Re: Creating maintenance window using setting API

victor_balbuena — Thu, 26 Oct 2023 13:25:01 GMT

You need to add square brackets at the start and end of your JSON or the API gets confused, so just add [ and ] at the start and end of your JSON body respectively.

Re: Creating maintenance window using setting API

gabrielsantos — Thu, 26 Oct 2023 13:33:17 GMT

Amazing Victor, thank you very much!

Re: Creating maintenance window using setting API

wipkumv3 — Thu, 25 Jan 2024 09:03:17 GMT

Hi,

Is there a way to fetch the entity ID against whom we need to create a maintenance window and use it in the same script, or how does it work to schedule MW for specific entity?

Re: Creating maintenance window using setting API

prakhardt — Fri, 03 Jan 2025 09:19:12 GMT

Hi Naveen

Please tell me how we have to deploy this json script so that we can automatically apply maintenance windows,or create an automated path for maintenance window.