---
title: "Create a maintenance event"
method: POST
path: "/v1/admin.maintenance.create"
tags: ["admin"]
---

# Create a maintenance event

`POST /v1/admin.maintenance.create`

## Request body

- CreateRequestBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `enabled` boolean, required — Whether the toggle is currently on
  - `endsAt` string, date-time
  - `message` string, required — Markdown body shown below the headline
  - `paths` string[], nullable, required — Path prefixes; "*" alone means whole site
  - `startsAt` string, date-time
  - `title` string, required — Short headline

## Response `200`

OK

- MaintenanceEvent, nullable
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `createdAt` string, date-time, required
  - `createdBy` integer
  - `enabled` boolean, required — Whether the toggle itself is on
  - `endsAt` string, date-time — Optional scheduled end
  - `message` string, required — Markdown body shown below the headline
  - `paths` string[], nullable, required — Path prefixes this event covers; "*" means whole site
  - `startsAt` string, date-time — Optional scheduled start
  - `title` string, required — Short headline shown to users
  - `uid` string, required — Public maintenance event ID
  - `updatedAt` string, date-time, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/steamsets/apis/steamsets-api.md) · [All operations](https://skmtc.net/steamsets/apis/steamsets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steamsets/steamsets-api/versions/2e8ba266b27f/schema)