> ## 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

> Not implemented for taps yet. It changes nothing and returns the current settings.



## OpenAPI

````yaml /spec.json delete /client/taps/{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/taps/{id}/configuration:
    delete:
      tags:
        - Tap configuration.
      summary: Reset configuration
      description: >-
        Not implemented for taps yet. It changes nothing and returns the current
        settings.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: The unique identifier for the tap
      responses:
        '200':
          description: The current settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tapSettingsResponse'
        '401':
          description: No access to this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Unauthorized
                statusCode: 401
                name: UnauthorizedError
        '404':
          description: Tap not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                message: Tap 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:
    tapSettingsResponse:
      type: object
      properties:
        active_timeout_s:
          type: integer
          description: Seconds the tap stays on after it is turned on.
          example: 120
        default_flow:
          type: number
          description: Flow the tap starts at, in L/min.
          example: 2
        default_temp:
          type: number
          description: Temperature the tap starts at, in °C.
          example: 36
        min_flow:
          type: number
          description: Lowest flow a user can set, in L/min.
          example: 1
        min_temp:
          type: number
          description: Lowest temperature a user can set, in °C.
          example: 1
        max_flow:
          type: number
          description: Highest flow a user can set, in L/min.
          example: 12
        max_temp:
          type: number
          description: Highest temperature a user can set, in °C.
          example: 44
        shower:
          type: boolean
          description: >-
            Switches the Control dial to a shower interface, for a tap that runs
            a shower.
          example: false
        theme:
          type: integer
          description: 'Control dial theme: `0` light, `1` dark.'
          example: 0
        time_zone_name:
          type: string
          description: IANA time zone of the tap, used for its clock.
          example: Europe/Stockholm
        units:
          type: integer
          description: >-
            Units shown on the Control dial: `0` metric (L/min, °C), `1`
            imperial (gpm, °F). The API always uses metric.
          example: 0
        wall_clock_12_hour_format:
          type: boolean
          description: Shows the Control dial clock in 12-hour (AM/PM) format.
          example: false
        wall_clock_enabled:
          type: boolean
          description: Shows a clock on the Control dial.
          example: false
        welcome_message_enabled:
          type: boolean
          description: Shows a welcome message when the tap is turned on.
          example: false
        welcome_message:
          type: string
          description: Text of the welcome message, under 36 bytes in UTF-8.
          example: Welcome!
    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.