Searching All Alert Maintenance Windows

You can search all alert maintenance windows using the following API.

Request URL

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

Header

Header key - Authorization

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

Request

{
"from": 0,
"keyword": "string",
"limit": 0,
"order": "ASC",
"sortBy": "createdAt"
}
ParametersDescription
keywordkeyword will be used to search alert maintenance window name
limitnumber of records to be returned
fromstarting no. of record
sortBy
  • lastUpdatedAt,
  • createdAt,
  • maintenanceName
  • order
  • ASC : Ascending
  • DESC : Descending
  • Example

    {
    "keyword": "Feb",
    "limit": 10,
    "from": 0,
    "sortBy": "lastUpdatedAt",
    "order": "DESC"
    }

    Response

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

    Example:

    {
    "message": "1 record(s) found",
    "success": true,
    "data": {
    "maintenanceWindows": [
    {
    "maintenanceId": "MGNiNGRjZGItZTZkOS00MzgyLTk3MDUtNjMzZjc3NDVhNDdmXzE2NzY5NjYxNTE0MjU=",
    "maintenanceName": "Feb 2023 maintenance 1",
    "rules": [
    "ZGUxOWNhOTAtY2Y3OC00MGRlLWI0NjktNTNjMWU3NGU3ZGEzXzE2NzUyNjAyNTIxMjM="
    ],
    "lastUpdatedBy": "API USER",
    "lastUpdatedAt": "2023-02-21T13:31",
    "createdBy": "API USER",
    "createdAt": "2023-02-21T13:25",
    "startTime": "2023-02-01T09:00",
    "endTime": "2023-02-01T10:00",
    "timezone": "IST"
    }
    ],
    "total": 1
    }
    }