# restoreConfiguration

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /json-rpc/confog/restore:
    post:
      summary: restoreConfiguration
      deprecated: false
      description: >-
        Restore a complete configuration.

        A restore will replace the current configuration database with the
        provided configuration. Instances are created in the order presented in
        the "instances" array. 

        Hyperion will be restarted afterwards to get the new setup activated.
      tags:
        - Hyperion API/Configuration
        - Websocket
        - HTTP/S
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                command:
                  type: string
                  description: The type of command to execute.
                  title: ''
                  enum:
                    - config
                  x-apidog-enum:
                    - value: config
                      name: ''
                      description: ''
                subcommand:
                  type: string
                  description: The type of sub-command to execute.
                  title: ''
                  enum:
                    - restoreconfig
                  x-apidog-enum:
                    - value: restoreconfig
                      name: ''
                      description: ''
                config:
                  $ref: '#/components/schemas/completeConfiguration'
                tan:
                  type: integer
                  minimum: 0
                  examples:
                    - 4711
                  description: Transaction number for tracking requests and responses.
              x-apidog-orders:
                - command
                - subcommand
                - config
                - 01JVJ7E63XJ3AT93N02BYRMBMF
              required:
                - command
                - subcommand
                - config
              x-apidog-refs:
                01JVJ7E63XJ3AT93N02BYRMBMF:
                  $ref: '#/components/schemas/tan'
              x-apidog-ignore-properties:
                - tan
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  command:
                    type: string
                    description: The command executed
                  subcommand:
                    type: string
                    description: The sub-command executed
                  success:
                    type: boolean
                    description: Result, if the request excuted successfully
                  info:
                    type: object
                    properties: {}
                    x-apidog-orders: []
                    description: Information requested
                    additionalProperties: true
                    x-apidog-ignore-properties: []
                  error:
                    type: string
                    description: Reason why a request did not execute successfully
                  errorData:
                    type: array
                    items:
                      type: object
                      properties:
                        description:
                          type: string
                      x-apidog-orders:
                        - description
                      x-apidog-ignore-properties: []
                    description: Detailed error explaination
                  tan:
                    type: integer
                    description: Request's transaction number
                x-apidog-orders:
                  - 01JV5M76DZ4M3GA4AD8Y4G69AP
                required:
                  - command
                  - success
                  - tan
                x-apidog-refs:
                  01JV5M76DZ4M3GA4AD8Y4G69AP:
                    $ref: '#/components/schemas/response'
                x-apidog-ignore-properties:
                  - command
                  - subcommand
                  - success
                  - info
                  - error
                  - errorData
                  - tan
              example:
                command: config-restoreconfig
                info: Restarting after importing configuration successfully.
                success: true
                tan: 4711
          headers: {}
          x-apidog-name: Success
      security:
        - bearer: []
      x-apidog-folder: Hyperion API/Configuration
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/894413/apis/api-17021599-run
components:
  schemas:
    completeConfiguration:
      type: object
      properties:
        global:
          type: object
          properties:
            settings:
              type: object
              properties:
                cecEvents:
                  type: string
                effects:
                  type: string
                flatbufServer:
                  type: string
                forwarder:
                  type: string
                framegrabber:
                  type: string
                general:
                  type: string
                grabberAudio:
                  type: string
                grabberV4L2:
                  type: string
                jsonServer:
                  type: string
                logger:
                  type: string
                network:
                  type: string
                osEvents:
                  type: string
                protoServer:
                  type: string
                schedEvents:
                  type: string
                webConfig:
                  type: string
              x-apidog-orders:
                - cecEvents
                - effects
                - flatbufServer
                - forwarder
                - framegrabber
                - general
                - grabberAudio
                - grabberV4L2
                - jsonServer
                - logger
                - network
                - osEvents
                - protoServer
                - schedEvents
                - webConfig
              x-apidog-ignore-properties: []
            uuid:
              type: string
              format: uuid
          additionalProperties: false
          x-apidog-orders:
            - settings
            - uuid
          required:
            - settings
          x-apidog-ignore-properties: []
        instanceIds:
          type: array
          items:
            $ref: '#/components/schemas/instance%20-%20single'
          minItems: 0
        instances:
          type: array
          items:
            type: object
            properties:
              enabled:
                type: boolean
              id:
                type: integer
                minimum: 0
                maximum: 255
              name:
                type: string
                minLength: 5
              settings:
                type: object
                properties:
                  backgroundEffect:
                    type: string
                  blackborderdetector:
                    type: string
                  boblightServer:
                    type: string
                  color:
                    type: string
                  device:
                    type: string
                  foregroundEffect:
                    type: string
                  instCapture:
                    type: string
                  ledConfig:
                    type: string
                  leds:
                    type: string
                  smoothing:
                    type: string
                x-apidog-orders:
                  - backgroundEffect
                  - blackborderdetector
                  - boblightServer
                  - color
                  - device
                  - foregroundEffect
                  - instCapture
                  - ledConfig
                  - leds
                  - smoothing
                x-apidog-ignore-properties: []
            x-apidog-orders:
              - enabled
              - id
              - name
              - settings
            required:
              - id
              - settings
            x-apidog-ignore-properties: []
      additionalProperties: false
      x-apidog-orders:
        - global
        - instanceIds
        - instances
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    instance - single:
      type: integer
      minimum: 0
      maximum: 254
      description: Instance index (0-254) to which the command applies.
      x-apidog-folder: ''
    tan:
      type: object
      properties:
        tan:
          type: integer
          minimum: 0
          examples:
            - 4711
          description: Transaction number for tracking requests and responses.
      x-apidog-orders:
        - tan
      title: tan
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
    response:
      type: object
      properties:
        command:
          type: string
          description: The command executed
        subcommand:
          type: string
          description: The sub-command executed
        success:
          type: boolean
          description: Result, if the request excuted successfully
        info:
          type: object
          properties: {}
          x-apidog-orders: []
          description: Information requested
          additionalProperties: true
          x-apidog-ignore-properties: []
        error:
          type: string
          description: Reason why a request did not execute successfully
        errorData:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
            x-apidog-orders:
              - description
            x-apidog-ignore-properties: []
          description: Detailed error explaination
        tan:
          type: integer
          description: Request's transaction number
      required:
        - command
        - success
        - tan
      x-apidog-orders:
        - command
        - subcommand
        - success
        - info
        - error
        - errorData
        - tan
      x-apidog-folder: ''
      x-apidog-ignore-properties: []
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: http://{{host}}:8090
    description: Develop Env
  - url: https://{{host}}:8092
    description: Testing Env
security: []

```