Sign in

v1

latestOpenAPI 3.0.02026-07-1310691106.0 KB
MaintenanceWindows

Describe maintenance window preferences for a stack.

get/{stack}/adminconfig/v2/maintenance-windows/preferences

Path parameters

stackstring required

The name of the stack.

Response

successfully described the maintenance window preferences for the stack

recordVersioninteger required

Version of the record.

warningstring

Warning message indicating feature eligibility status. Present only when stack is not enabled for preferred maintenance windows feature.

Example response

{
  "changeFreezes": {
    "customerInitiatedFreezes": [
      {
        "appliesTo": "Splunk Initiated Changes Only",
        "createdTimestamp": "2006-02-01T15:04:05Z",
        "endDate": "2006/02/01",
        "lastModifiedTimestamp": "2006-02-01T15:04:05Z",
        "reason": "Black Friday/Cyber Monday Sales Week",
        "startDate": "2006/02/01",
        "tickets": [
          "1001234",
          "1001235"
        ],
        "ticketsV2": [
          {
            "id": "1000123",
            "type": "SFDC",
            "url": "https://splunk.my.site.com/customer/s/case/500KW0000000123ABC"
          }
        ]
      }
    ],
    "splunkInitiatedFreezes": [
      {
        "appliesTo": "Splunk Initiated Changes Only",
        "category": "Professional Services",
        "endDate": "2006/02/01",
        "reason": "Splunk Holiday",
        "startDate": "2006/02/01",
        "tickets": [
          "1001234",
          "1001235"
        ],
        "ticketsV2": [
          {
            "id": "1000123",
            "type": "SFDC",
            "url": "https://splunk.my.site.com/customer/s/case/500KW0000000123ABC"
          }
        ]
      }
    ]
  },
  "preferredSchedule": {
    "additionalPreferences": [
      {
        "daysOfWeek": [
          "Monday"
        ],
        "timeSlot": {
          "end": "21:00",
          "start": "13:00"
        }
      }
    ],
    "preferredWindow": {
      "alternateDays": [
        "Monday"
      ],
      "preferredDay": "Monday",
      "timeSlot": {
        "end": "21:00",
        "start": "13:00"
      }
    }
  }
}