---
title: "Service maintenance check"
method: GET
path: "/maintenance"
tags: ["information"]
---

# Service maintenance check

`GET /maintenance`

## Request

- Base URL: `/efs-submissions-api` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/efs-submissions-api/maintenance`
- Auth: none declared
- TypeScript: <https://skmtc.dev/companies-house/apis/emergency-filing-service-api/docs/maintenance/get.ts> (a function with typed inputs; its response is checked against the schema)

Checks the service configuration for a planned maintenance period.

## Response `200`

OK - maintenance check successful

- MaintenanceStatus
  - `status` 'UP' | 'DOWN' | 'OUT_OF_SERVICE', required
  - `message` string, required
  - `maintenance_start_time` string, date-time
  - `maintenance_end_time` string, date-time

## Changes

- **2023-11-15** `8877cf9e7102`: 1 info
  - removed the non-success response with the status `503`
- **2023-11-14** `e3fcbcb88b15`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/changes/maintenance/get.md)

---

[API](https://skmtc.dev/companies-house/apis/emergency-filing-service-api.md) - [All operations](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/revisions/7dbd2ded46b4?raw)