---
title: "Start maintenance mode for routing keys"
method: POST
path: "/api-public/v1/maintenancemode/start"
tags: ["Maintenance Mode"]
---

# Start maintenance mode for routing keys

`POST /api-public/v1/maintenancemode/start`

## Headers

- `X-VO-Api-Id` string, required
- `X-VO-Api-Key` string, required

## Request body

- object
  - `type` 'RoutingKeys'
  - `names` string[] — Routing keys that maintenance mode state covers. An empty list indicates global maintenance mode
  - `purpose` string — the reason for the maintenance mode

## Response `200`

maintenance mode state

- MaintenanceModeState
  - `companyId` string
  - `activeInstances` ActiveMaintenanceMode[]
    - `instanceId` string — external friendly unique id for maintenance mode
    - `startedBy` string — username of the user that started maintenance mode
    - `startedAt` number — millis from epoch marking the start time
    - `targets` MaintenanceModeTarget[]
      - `type` 'RoutingKeys'
      - `names` string[] — Routing keys that maintenance mode state covers. An empty list indicates global maintenance mode
    - `isGlobal` boolean — whether this instance is a global maintenance mode or for specific routing keys

## Other responses

- `403` — Authentication failed or rate-limit reached
- `409` — You have an active global maintanance mode and are attempting to start a second. You may only have a single Global maintenance mode at a time
- `420` — You have reached the limit of allowed active maintenance modes
- `500` — Internal Server Error

---

[API](https://skmtc.net/victorops/apis/victorops-api.md) · [All operations](https://skmtc.net/victorops/apis/victorops-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/victorops/victorops-api/revisions/7a7391256058/schema)