HTTP REST API¶
This section provides detailed information about the keylightd API endpoints, request/response formats, and authentication mechanisms.
Overview¶
The keylightd HTTP API provides comprehensive control over Elgato Key Light devices through standard REST endpoints. The API supports:
- Device discovery and status monitoring
- Individual light control (power, brightness, temperature)
- Group management for controlling multiple lights
- API key management for authentication
- Real-time device state synchronization
Base URL¶
The API is available at:
The default port is 9123, but this can be configured in the keylightd configuration file.
OpenAPI Specification¶
The keylightd API follows the OpenAPI 3.1.0 specification. You can explore the interactive documentation below or download the OpenAPI specification for use with other tools.