REST-API

The REST-API for Innosonix Devices

All function, the devices offers are available via the integrated REST-API.

The API is based on HTTP PUT / GET / OPTIONS / DELETE calls with JSON payload.

Every PUT / DELETE call has to be verified via a “Authentication Token” in the HTTP header. The default token is: “f4005bf8507999192162d989d5a60823”

This documentation is more dedicated as general overview and description how to handle the API. Each device includes the latest API-Documentation with all available calls.

It can be found on the lower right corner of the OVERVIEW page:

Overall Structure

It’s an hierarchical REST API with partial resource updates, structured per channel and it’s corresponding resources like DSP / EQ / VOLUME / etc.

That means you can basically update the whole device with up to 32 channels, with a single HTTP PUT call like a HTTP PUT on http://{IP}/rest-api/settings with a json payload containing the requested structure.

  • settings/
    • channel/
      • 1/
        • ampenable
        • dsp/
          • delay
          • eq
          • fir
          • mute
      • 2/
        • ampenable
        • dsp/
          • delay
          • eq
          • fir
          • mute
      • etc…
    • device/
      • dante/
    • etc…

On the other hand, update single resources down in the tree is also possible, e.g. http://{IP}/rest-api/settings/channel/1/ampenable


Examples

Some REST-API use cases

Last modified October 7, 2024: add some rest-api examples (af49b3e)