Creating Alert Maintenance Window

You can create alert alert maintenance window using the following API.

Request URL

POST https://http-collector-observability.sixthsense.rakuten.com/api-externalization/api/v1/maintenance/

Header

Header key - Authorization

Header value - Bearer {{access_token}} (Navigate to Settings > Access token > Show access token in the SixthSence portal.)

Request

{
"endTime": "string",
"maintenanceName": "string",
"rules": [
"string"
],
"startTime": "string",
"timezone": "string"
}
ParametersDescription
endTime
  • Should be in "YYYY-MM-DD'T'HH:mm" format.
  • Should be greater than startTime.
  • endTime should greater than startTime by at least 5 min
    • maintenanceNameMaintenance Name of length 100
    ruleIdsList of ruleIds up to 100 Ids.
    startTime
  • Should be in "YYYY-MM-DD'T'HH:mm" format.
  • Should be greater than current time.
    • timezoneRecognised 3 digits of timezone like "IST", "UTC" etc.

    Example:

    {
    "maintenanceName": "Feb 2023 maintenance",
    "startTime": "2023-02-01T09:00",
    "endTime": "2023-02-01T10:00",
    "rules": [
    "ZGUxOWNhOTAtY2Y3OC00MGRlLWI0NjktNTNjMWU3NGU3ZGEzXzE2NzUyNjAyNTIxMjM="
    ],
    "timezone": "IST"
    }

    Response

    {
    "data": {},
    "message": "string",
    "success": true
    }

    Example:

    {
    "message": "Alert maintenance created successfully.",
    "success": true,
    "data": {
    "maintenanceId": "MGNiNGRjZGItZTZkOS00MzgyLTk3MDUtNjMzZjc3NDVhNDdmXzE2NzY5NjYxNTE0MjU=",
    "maintenanceName": "Feb 2023 maintenance",
    "rules": [
    "ZGUxOWNhOTAtY2Y3OC00MGRlLWI0NjktNTNjMWU3NGU3ZGEzXzE2NzUyNjAyNTIxMjM="
    ],
    "lastUpdatedBy": "API USER",
    "lastUpdatedAt": "2023-02-21T13:25",
    "createdBy": "API USER",
    "createdAt": "2023-02-21T13:25",
    "startTime": "2023-02-01T09:00",
    "endTime": "2023-02-01T10:00",
    "timezone": "IST"
    }
    }