# updateConfiguration

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /json-rpc/config/update:
    post:
      summary: updateConfiguration
      deprecated: false
      description: >-
        Update configuration items. 

        Sets of configuration items can be given differentiating global ones and
        instance specific.
      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:
                    - setconfig
                  x-apidog-enum:
                    - value: setconfig
                      name: ''
                      description: ''
                config:
                  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: []
                      additionalProperties: false
                      x-apidog-orders:
                        - settings
                      required:
                        - settings
                      x-apidog-ignore-properties: []
                    instances:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            minimum: 0
                            maximum: 255
                          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:
                          - id
                          - settings
                        required:
                          - settings
                        x-apidog-ignore-properties: []
                  x-apidog-refs: {}
                  x-apidog-orders:
                    - global
                    - instances
                  x-apidog-ignore-properties: []
                tan:
                  type: integer
                  minimum: 0
                  examples:
                    - 4711
                  description: Transaction number for tracking requests and responses.
              x-apidog-orders:
                - command
                - subcommand
                - config
                - 01JVJ2V0BJZKGDKB42Y9ZCBEA4
              required:
                - command
                - subcommand
                - config
              x-apidog-refs:
                01JVJ2V0BJZKGDKB42Y9ZCBEA4:
                  $ref: '#/components/schemas/tan'
              x-apidog-ignore-properties:
                - tan
            example:
              command: config
              subcommand: setconfig
              config:
                instances:
                  - id: 1
                    settings:
                      foregroundEffect:
                        color:
                          - 0
                          - 0
                          - 255
                        duration_ms: 3000
                        effect: Rainbow swirl fast
                        enable: true
                        type: effect
              tan: 4711
      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
              examples:
                '1':
                  summary: Success
                  value:
                    command: config-setconfig
                    success: true
                    tan: 4711
                '2':
                  summary: Exception
                  value:
                    command: config-setconfig
                    error: Invalid params
                    errorData:
                      - description: >-
                          JSON parse error @(JsonRpc@::1) - 
                          [root].config.instances[0].settings.wrongElement: no
                          schema definition
                    success: false
                    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-17021074-run
components:
  schemas:
    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: []

```