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

# Reset configuration

> Resets the settings to their defaults and returns them.



## OpenAPI

````yaml /spec.json delete /client/showers/{id}/configuration
openapi: 3.0.4
info:
  title: Orbital API
  version: 1.0.0
  description: >-
    Send your API key in the `x-api-key` header of every request. The key
    belongs to one Orbital account, and requests act as that account: they see
    and control only the devices it owns or has been given access to. A missing
    or unknown key gets `403` with `{ "message": "Forbidden" }`.
servers:
  - url: https://api.orbital-systems.com
    description: Production
  - url: https://stage-api.orbital-systems.com
    description: Staging
  - url: https://dev-api.orbital-systems.com
    description: Development
security:
  - apiKeyAuth: []
tags: []
paths:
  /client/showers/{id}/configuration:
    delete:
      tags:
        - Shower configuration.
      summary: Reset configuration
      description: Resets the settings to their defaults and returns them.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: The unique identifier for the shower
      responses:
        '200':
          description: The settings after the reset
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/showerSettingsResponse'
        '401':
          description: No access to this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Unauthorized
                statusCode: 401
                name: UnauthorizedError
        '404':
          description: Shower not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Shower not found
                statusCode: 404
                name: NotFoundError
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Internal server error
components:
  schemas:
    showerSettingsResponse:
      type: object
      properties:
        boost_flow_enabled:
          type: boolean
          description: Lets users raise the flow above the normal maximum.
          example: false
        cleaning_program_liters_limit:
          type: number
          description: Litres of water the shower can use before it asks for descaling.
          example: 2440
        cleaning_program_sessions_limit:
          type: integer
          description: >-
            Sessions the shower can run before it asks for descaling. Only used
            by older showers.
          example: 20
        cleaning_program_sessions_limit_enabled:
          type: boolean
          description: Whether the shower asks for descaling when its limit is reached.
          example: true
        color_mode:
          type: integer
          description: 'Control dial theme: `0` light, `1` dark.'
          example: 0
        daily_hot_water_treatment_enabled:
          type: boolean
          description: >-
            Runs a heat-cycle cleaning every day at
            `daily_hot_water_treatment_time`.
          example: true
        daily_hot_water_treatment_time:
          type: string
          pattern: ^(0[0-9]|1[0-9]|2[0-3])[0-5][0-9]$
          description: Time of the daily heat cycle, as `HHMM` in the shower’s local time.
          example: '0300'
        default_recirculation_mode:
          type: number
          description: >-
            Savings mode a session starts in: `1` Legacy (no recirculation), `2`
            Earth, `3` Moon, `4` Mars.
          example: 2
        default_shower_flow:
          type: number
          description: Flow a session starts at, in L/min. 4–12.
          example: 9
        heater_power_available:
          type: number
          description: Heater power the installation allows, in kW.
          example: 3.2
        hot_water_treatment_per_session_enabled:
          type: boolean
          description: Runs a heat cycle after every session.
          example: false
        is_private_shower:
          type: boolean
          description: >-
            Whether the shower is in a home (`true`) or a business such as a gym
            or hotel (`false`).
          example: true
        is_wall_clock_12_hour_format:
          type: boolean
          description: Shows the Control dial clock in 12-hour (AM/PM) format.
          example: false
        is_wall_clock_enabled:
          type: boolean
          description: Shows a clock on the Control dial.
          example: true
        live_data_rate:
          type: integer
          description: >-
            How often the shower sends live data: `0` off, `1` fast (at least
            once a second), `2` auto (the shower decides).
          example: 2
        max_shower_water_flow:
          type: number
          description: Highest flow a user can set, in L/min. 4–12.
          example: 12
        min_conservation_flow:
          type: number
          description: Lowest flow eco flow (`water_conservation`) may drop to, in L/min.
          example: 6.5
        min_shower_water_flow:
          type: number
          description: Lowest flow a user can set, in L/min. 4–12.
          example: 5
        shower_head_hc_enabled:
          type: boolean
          description: >-
            Also flushes the shower head with hot water during the scheduled
            heat cycle.
          example: false
        shower_water_temperature_fahrenheit:
          type: boolean
          description: >-
            Shows temperatures on the Control dial in °F. The API always uses
            °C.
          example: false
        shower_water_temperature_max:
          type: number
          description: Highest temperature a user can set, in °C. 0–50.
          example: 45
        shower_water_temperature_min:
          type: number
          description: Lowest temperature a user can set, in °C. 0–50.
          example: 15
        shower_water_temperature_start:
          type: number
          description: Temperature a session starts at, in °C. 0–50.
          example: 38
        state_active_showering_timer:
          type: integer
          description: Seconds of showering before the shower pauses by itself.
          example: 1800
        state_standby_no_user_wait_timer:
          type: integer
          description: Seconds paused with nobody in the shower before the session ends.
          example: 60
        state_standby_wait_timer:
          type: integer
          description: Seconds paused before the session ends.
          example: 180
        time_zone_name:
          type: string
          description: >-
            IANA time zone of the shower, used for its clock and scheduled
            cleaning.
          example: Europe/Stockholm
        use_estimation_for_drain_temperature:
          type: boolean
          description: Estimates the drain water temperature instead of measuring it.
          example: false
        water_conservation:
          type: boolean
          description: >-
            Eco flow: lowers the flow (down to `min_conservation_flow`) to keep
            recirculating instead of switching to fresh water.
          example: false
        welcome_message_enabled:
          type: boolean
          description: >-
            Shows a welcome message when someone steps into the shower. Only in
            businesses (`is_private_shower: false`).
          example: false
        welcome_message:
          type: string
          description: >-
            Text of the welcome message, under 36 bytes in UTF-8. An empty
            string shows the default message in the shower’s language.
          example: Welcome!
        water_hardness:
          type: number
          minimum: 1
          maximum: 30
          description: >-
            Hardness of the incoming water, in °dH. 1–30. Setting it sets
            `cleaning_program_liters_limit` to match. Returned only when the
            limit matches a hardness.
          example: 8
        language:
          type: string
          description: >-
            Language shown on the Control dial, as an ISO 639-1 code. Not
            supported by older showers. Left out for older showers or a language
            without a code.
          example: de
        available_languages:
          type: array
          items:
            type: string
          description: >-
            Language codes that can be set (currently en, de, fr). Left out for
            older showers.
          example:
            - en
            - de
            - fr
    error:
      type: object
      description: Returned with every 4xx and 5xx response.
      required:
        - message
      properties:
        message:
          type: string
          description: What went wrong.
        name:
          type: string
          description: Kind of error. Not set on a `500`.
        statusCode:
          type: integer
          description: HTTP status code, repeated from the response. Not set on a `500`.
        code:
          type: integer
          enum:
            - 1
            - 2
          description: >-
            Set on a `403` from pairing a device someone else owns: `1` the
            owner doesn’t accept sharing requests, `2` a sharing request was
            sent to the owner.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Send your API key in the `x-api-key` header of every request. The key
        belongs to one Orbital account, and requests act as that account: they
        see and control only the devices it owns or has been given access to. A
        missing or unknown key gets `403` with `{ "message": "Forbidden" }`.

````

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