> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentivel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schedule a maintenance window

> Publish a planned-work notice on the workspace's status pages. The common use is a deploy pipeline: open a window when a release starts, then PATCH `status: "complete"` when it finishes. Omit `componentIds` to say the whole workspace is affected.



## OpenAPI

````yaml https://www.sentivel.com/api/v1/openapi.json post /maintenance
openapi: 3.1.0
info:
  title: Sentivel API
  version: 1.0.0
  description: >-
    Provision and read your Sentivel workspace programmatically: components,
    monitors, status pages and incidents. Authenticate with an org API token
    (create one under Developers → API tokens in the dashboard).
  contact:
    name: Sentivel
    url: https://www.sentivel.com
servers:
  - url: https://www.sentivel.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Identity
    description: Who the token is
  - name: Components
    description: Status-page components (status units)
  - name: Monitors
    description: Uptime/HTTP checks
  - name: Status pages
    description: Public status pages
  - name: Incidents
    description: Incidents (read + manual create)
  - name: People
    description: Workspace members
  - name: Integrations
    description: Outbound alert destinations
  - name: On-call
    description: On-call schedules
  - name: Maintenance
    description: Scheduled maintenance windows
paths:
  /maintenance:
    post:
      tags:
        - Maintenance
      summary: Schedule a maintenance window
      description: >-
        Publish a planned-work notice on the workspace's status pages. The
        common use is a deploy pipeline: open a window when a release starts,
        then PATCH `status: "complete"` when it finishes. Omit `componentIds` to
        say the whole workspace is affected.
      operationId: createMaintenance
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaintenanceCreate'
      responses:
        '201':
          description: The scheduled window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Maintenance'
        '400':
          description: Missing title, or the end time isn't after the start.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token's role can't manage status pages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    MaintenanceCreate:
      type: object
      required:
        - title
        - startsAt
        - endsAt
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 200
        body:
          type: string
          maxLength: 4000
        startsAt:
          type: string
          format: date-time
          description: ISO 8601 with an offset, e.g. 2026-09-01T22:00:00Z.
        endsAt:
          type: string
          format: date-time
        componentIds:
          type: array
          maxItems: 200
          items:
            type: string
            format: uuid
          description: Omit or leave empty to mean the whole workspace.
    Maintenance:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
          description: The headline customers see.
        body:
          type: string
          description: The public explanation.
        status:
          type: string
          enum:
            - scheduled
            - in_progress
            - completed
            - cancelled
          description: >-
            Where the window sits right now. Derived from the clock — only
            `cancelled` is a stored state.
        startsAt:
          type: string
          format: date-time
        endsAt:
          type: string
          format: date-time
        components:
          type: array
          description: Components the window affects. Empty = the whole workspace.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - internal
            message:
              type: string
            details:
              type: object
          required:
            - code
            - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Sent as `Authorization: Bearer <token>`. Three kinds are accepted: an
        ORG token (`sv_…`), bound to one workspace with a fixed role; a PERSONAL
        token (`svu_…`), which acts as you with your own live role in whichever
        workspace it is pointed at; and an OAUTH access token (`mcp_at_…`) from
        a connected app, limited to the workspaces you granted it. A personal or
        OAuth token names its workspace with the `X-Sentivel-Workspace` header
        (a slug or an id). Without it an OAuth token falls back to the
        connection's primary workspace, while a personal token in more than one
        workspace is rejected `400 invalid_request` with the choices in
        `error.details.workspaces`. Membership is re-read every request, so
        leaving a workspace or revoking the grant takes effect at once.

````