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

# Scheduled outage status

> Returns the current platform outage state. `ok` means no outage is reported. `scheduled_outage` is returned during the daily 17:00–18:00 America/New_York maintenance window. `unscheduled_outage` is reserved for unplanned outage reporting.



## OpenAPI

````yaml /openapi.json get /api/maintenance/
openapi: 3.0.3
info:
  title: TBBO API
  version: 1.0.0
  description: >
    Authentication uses short-lived session tokens (3 hours).


    Send the token with every request using the `Authorization` header:


    ```

    Authorization: Token <token>

    ```


    Example:


    ```

    Authorization: Token 123abc456def789

    ```


    To obtain a token, call `POST /auth/login/` with valid credentials. The
    response includes a `key` value. Use that value in the header above for
    subsequent API calls.


    How to find required IDs:


    - `challenge_id`: Prop Tech Configuration -> Challenges

    - `user_id`: Tickblaze Manager -> Users

    - `account_id`: Tickblaze Manager -> Accounts 
servers: []
security: []
tags:
  - name: withdrawals
    description: Withdrawal related endpoints
    x-displayName: Withdrawals
paths:
  /api/maintenance/:
    get:
      tags:
        - Status
      summary: Scheduled outage status
      description: >-
        Returns the current platform outage state. `ok` means no outage is
        reported. `scheduled_outage` is returned during the daily 17:00–18:00
        America/New_York maintenance window. `unscheduled_outage` is reserved
        for unplanned outage reporting.
      operationId: api_maintenance_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledOutage'
              examples:
                OK:
                  value:
                    status: ok
                  summary: Platform operating normally
                ScheduledOutage:
                  value:
                    status: scheduled_outage
                  summary: >-
                    Within the daily 17:00–18:00 America/New_York maintenance
                    window
          description: ''
      security:
        - {}
components:
  schemas:
    ScheduledOutage:
      type: object
      properties:
        status:
          allOf:
            - $ref: '#/components/schemas/ScheduledOutageStatusEnum'
          description: >-
            Current outage state. `ok` means no outage is reported;
            `scheduled_outage` is returned during the daily 17:00–18:00
            America/New_York maintenance window; `unscheduled_outage` is
            reserved for unplanned outage reporting.


            * `ok` - ok

            * `scheduled_outage` - scheduled_outage

            * `unscheduled_outage` - unscheduled_outage
      required:
        - status
    ScheduledOutageStatusEnum:
      enum:
        - ok
        - scheduled_outage
        - unscheduled_outage
      type: string
      description: |-
        * `ok` - ok
        * `scheduled_outage` - scheduled_outage
        * `unscheduled_outage` - unscheduled_outage

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.