# Maintenance

Maintenance represents an event that:
- Has known start time which is typically in future - planned maintenance,
- Has known end time during the moment of creation,
- Is a single message.

Most typical use case:
- Hub Page list various customer-facing services,
- One of the service will undergo a maintenance that will take it offline
  for duration of the maintenance,
- Ahead of time, Maintenance event is created to let customers know
  that service will not be available during the specific time frame.


## Create a Maintenance event

 - [POST /hubs/{subdomain}/maintenances](https://api-docs.statushub.com/api-v3-openapi/maintenance/createmaintenance.md): Creates a new Maintenance.

## List Maintenance events

 - [GET /hubs/{subdomain}/maintenances](https://api-docs.statushub.com/api-v3-openapi/maintenance/listmaintenances.md): Filters and returns Maintenance records for current Hub with basic info.

## Retrieve a Maintenance event

 - [GET /hubs/{subdomain}/maintenances/{maintenance_id}](https://api-docs.statushub.com/api-v3-openapi/maintenance/getmaintenance.md): Returns data about single maintenance event.

## Update a Maintenance event

 - [PUT /hubs/{subdomain}/maintenances/{maintenance_id}](https://api-docs.statushub.com/api-v3-openapi/maintenance/updatemaintenance.md): Modifies an existing Maintenance. Only modified attributes may be passed in payload. All other attributes will remain unchanged.

## Delete a Maintenance event

 - [DELETE /hubs/{subdomain}/maintenances/{maintenance_id}](https://api-docs.statushub.com/api-v3-openapi/maintenance/deletemaintenance.md): Deletes Maintenance record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored.