APapaleo
Maintenance

Create a new maintenance window

Use this call to create a new maintenance window for the given unit. You can only create maintenances for today and days in the future.<br>You must have at least one of these scopes: 'maintenances.create, maintenances.manage'.<br>For fine-grained clients, you must have this permission: 'core.maintenances.create'.

post/operations/v1/maintenances

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/operations/v1/maintenances
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: maintenances.create, maintenances.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

unitIdstring required

The id of the unit

fromstring date-time required

Date and time the maintenance begins. Has to be today or on a day in the future<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time required

Date and time the maintenance ends. Has to be later than from<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

type'OutOfService' | 'OutOfOrder' | 'OutOfInventory' required

The type of maintenance that is planned for the unit. A small repair (OutOfService), a bigger disfunction that does not allow to sell the unit (OutOfOrder) or is it under construction (OutOfInventory)

descriptionstring nullable

Description of the maintenance

Example request

{
  "unitId": "MUC-JQI",
  "from": "2026-10-15T12:15:11+02:00",
  "to": "2026-10-17T12:15:11+02:00",
  "type": "OutOfService",
  "description": "The remote control for the TV needs to be replaced."
}

Response

Creation of the new maintenance was successful.

idstring required

The id for the scheduled maintenance

Example response

{
  "id": "MUC-JQI-SGHZD"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.