Sign in

v1

latestOpenAPI 3.0.02026-07-1310691106.0 KB
MaintenanceWindows

Describe a specific maintenance window schedule

get/{stack}/adminconfig/v2/maintenance-windows/schedules/{scheduleID}

Path parameters

stackstring required

The name of the stack.

scheduleIDstring required

The maintenance window schedule ID.

Response

successfully described a specific maintenance window schedule

durationstring required

The duration of the maintenance window. Format is a Go duration string.

extendedDurationstring

The duration of the maintenance window schedule extension. Format is a Go duration string.

lastModifiedTimestampstring date-time required

Time at which the maintenance window was last modified. Format is RFC3339.

maintenanceEndedAtstring date-time

Time at which the maintenance window actually ended. This field is populated only after the window ends. Format is RFC3339.

maintenanceStartedAtstring date-time

Time at which the maintenance window actually started. This field is populated only after the window begins. Format is RFC3339.

mwTypestring required

The type of upgrade performed in the maintenance window.

requestedEntitystring required

The entity which requested the maintenance window, either the customer or Splunk.

requestedUserstring

The user who requested the maintenance window.

scheduleEndTimestampstring date-time required

Time at which the maintenance window is scheduled to end. Format is RFC3339.

scheduleIdstring required

UUID of the maintenance window.

scheduleStartTimestampstring date-time required

Time at which the maintenance window is scheduled to begin. Format is RFC3339.

statusstring required

The status of the maintenance window schedule.

zeroDowntimeboolean required

True if the maintenance window will have no impact on the uptime of the stack.

Example response

{
  "operations": [
    {
      "SFDCTickets": [
        "1001234",
        "1001235"
      ],
      "tickets": [
        {
          "id": "1000123",
          "type": "SFDC",
          "url": "https://splunk.my.site.com/customer/s/case/500KW0000000123ABC"
        }
      ]
    }
  ]
}