Sign in

v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB
admin

Create a maintenance event

post/v1/admin.maintenance.create

Request body

$schemastring uri

A URL to the JSON Schema for this object.

enabledboolean required

Whether the toggle is currently on

endsAtstring date-time
messagestring required

Markdown body shown below the headline

pathsstring[] nullable required

Path prefixes; "*" alone means whole site

startsAtstring date-time
titlestring required

Short headline

Example request

{
  "$schema": "https://api.steamsets.com/schemas/CreateRequestBody.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"
}