information

Service maintenance check

Changed on Nov 15, 2023

Checks the service configuration for a planned maintenance period.

get/maintenance

Request

Base URL
/efs-submissions-api (relative, and the document was published on a file host, not at the API’s origin)
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.

Response

OK - maintenance check successful

status'UP' | 'DOWN' | 'OUT_OF_SERVICE' required

messagestring required

maintenance_start_timestring date-time

maintenance_end_timestring date-time

Example response

{
  "status": "UP",
  "message": "No planned maintenance is configured",
  "maintenance_start_time": "2023-11-13T05:10:00Z",
  "maintenance_end_time": "2023-11-13T05:50:00Z"
}

Changes

Nov 15, 20238877cf9e7102 Revision changes
- info
  removed the non-success response with the status
Nov 14, 2023e3fcbcb88b15 Revision changes
- info
  endpoint added

Operation history

Service maintenance check

Request

Response 200OK

Example response

Changes

Response