Sign in

v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB
admin

Update a maintenance event (any subset of fields)

post/v1/admin.maintenance.update

Request body

$schemastring uri

A URL to the JSON Schema for this object.

clearEndsAtboolean
clearStartsAtboolean
enabledboolean
endsAtstring date-time
messagestring
pathsstring[]
startsAtstring date-time
titlestring
uidstring required

Example request

{
  "$schema": "https://api.steamsets.com/schemas/UpdateRequestBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

createdAtstring date-time required
createdByinteger
enabledboolean required

Whether the toggle itself is on

endsAtstring date-time

Optional scheduled end

messagestring required

Markdown body shown below the headline

pathsstring[] nullable required

Path prefixes this event covers; "*" means whole site

startsAtstring date-time

Optional scheduled start

titlestring required

Short headline shown to users

uidstring required

Public maintenance event ID

updatedAtstring date-time required

Example response

{
  "$schema": "https://api.steamsets.com/schemas/MaintenanceEvent.json"
}