# getConfiguration ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /json-rpc/config: post: summary: getConfiguration deprecated: false description: >- Get configuration items which are global or instance specific. Sets of configuration items can be filtered by provided a list of configuration items to be returned. tags: - Hyperion API/Configuration - Websocket - HTTP/S parameters: [] requestBody: content: application/json: schema: type: object properties: command: type: string enum: - config x-apidog-enum: - value: config name: '' description: '' subcommand: type: string enum: - getconfig x-apidog-enum: - value: getconfig name: '' description: '' configFilter: type: object properties: global: type: object properties: types: type: array items: type: string examples: - general enum: - cecEvents - effects - flatbufServer - forwarder - framegrabber - general - grabberAudio - grabberV4L2 - jsonServer - logger - network - osEvents - protoServer - schedEvents - webConfig x-apidog-enum: - value: cecEvents name: '' description: '' - value: effects name: '' description: '' - value: flatbufServer name: '' description: '' - value: forwarder name: '' description: '' - value: framegrabber name: '' description: '' - value: general name: '' description: '' - value: grabberAudio name: '' description: '' - value: grabberV4L2 name: '' description: '' - value: jsonServer name: '' description: '' - value: logger name: '' description: '' - value: network name: '' description: '' - value: osEvents name: '' description: '' - value: protoServer name: '' description: '' - value: schedEvents name: '' description: '' - value: webConfig name: '' description: '' uniqueItems: true x-apidog-orders: - types x-apidog-ignore-properties: [] instances: type: object properties: ids: type: array items: &ref_0 $ref: '#/components/schemas/instance%20-%20single' uniqueItems: true minItems: 1 types: type: array items: type: string enum: - 'backgroundEffect ' - 'blackborderdetector ' - 'boblightServer ' - 'color ' - 'device ' - 'foregroundEffect ' - 'instCapture ' - 'ledConfig ' - 'leds ' - 'smoothing ' x-apidog-enum: - value: 'backgroundEffect ' name: '' description: '' - value: 'blackborderdetector ' name: '' description: '' - value: 'boblightServer ' name: '' description: '' - value: 'color ' name: '' description: '' - value: 'device ' name: '' description: '' - value: 'foregroundEffect ' name: '' description: '' - value: 'instCapture ' name: '' description: '' - value: 'ledConfig ' name: '' description: '' - value: 'leds ' name: '' description: '' - value: 'smoothing ' name: '' description: '' examples: - device uniqueItems: true required: - ids x-apidog-orders: - ids - types x-apidog-ignore-properties: [] x-apidog-orders: - global - instances x-apidog-ignore-properties: [] tan: type: integer minimum: 0 examples: - 4711 description: Transaction number for tracking requests and responses. required: - command - subcommand x-apidog-orders: - command - subcommand - configFilter - 01JVJ0TYKV10RV03C7YD4131C7 x-apidog-refs: 01JVJ0TYKV10RV03C7YD4131C7: $ref: '#/components/schemas/tan' x-apidog-ignore-properties: - tan examples: '1': value: command: config subcommand: getconfig tan: 4711 summary: Complete description: Get the complete configuration. '2': value: command: config subcommand: getconfig configFilter: global: types: - cecEvents - general tan: 4711 summary: Select global elements description: Get selected global configuration items. '3': value: command: config subcommand: getconfig configFilter: instances: ids: - 0 - 1 types: - device - leds tan: 4711 summary: Select instance elements description: >- Get selected instance specific configuration items for a list of instances. '4': value: command: config subcommand: getconfig configFilter: global: types: [] instances: ids: [] types: [] tan: 4711 summary: All types description: Do not filter for specific configuration types. '5': value: command: config subcommand: getconfig configFilter: global: null instances: null tan: 4711 summary: Exclude description: Exclude instances and/or global information by giving "null". '6': value: command: config subcommand: getconfig configFilter: global: types: null instances: ids: [] types: null tan: 4711 summary: Instance info only description: Get information about all instances, but no settings. 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: description: Information requested $ref: '#/components/schemas/completeConfiguration' 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: - command - subcommand - success - info - error - errorData - tan x-apidog-refs: {} required: - command - success - tan x-apidog-ignore-properties: [] examples: '1': summary: Success - Global filter value: command: config-getconfig info: global: settings: cecEvents: actions: - action: Suspend event: standby - action: Resume event: set stream path enable: false general: configVersion: 2.0.17-beta.3 name: My Hyperion Config showOptHelp: true watchedVersionBranch: Stable uuid: ba85a700-65fe-51e8-97d5-a24dbf47c547 success: true tan: 4711 '2': summary: Success - Instance filter value: command: config-getconfig info: instanceIds: - 0 - 1 instances: - enabled: false id: 0 name: 1st instance settings: device: autoStart: true colorOrder: rgb enableAttempts: 6 enableAttemptsInterval: 15 hardwareLedCount: 1 latchTime: 0 output: /dev/null rewriteTime: 0 type: file leds: - hmax: 1 hmin: 0 vmax: 0.08 vmin: 0 - enabled: false id: 1 name: 2nd instance settings: device: autoStart: true colorOrder: rgb enableAttempts: 6 enableAttemptsInterval: 15 hardwareLedCount: 1 latchTime: 0 output: /dev/null rewriteTime: 0 type: file leds: - hmax: 1 hmin: 0 vmax: 0.08 vmin: 0 success: true tan: 4711 '3': summary: Success - Instance info only value: command: config-getconfig info: instanceIds: - 0 - 1 instances: - enabled: false id: 0 name: 1st instance settings: {} - enabled: false id: 1 name: 2nd instance settings: {} 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-17020899-run components: schemas: 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: [] 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_0 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: '' securitySchemes: bearer: type: http scheme: bearer servers: - url: http://{{host}}:8090 description: Develop Env - url: https://{{host}}:8092 description: Testing Env security: [] ```