Pearl REST API apply configuration presets
Configuration presets are saved device configurations. The API can list the presets stored on a Pearl device and apply one, optionally restricting the apply to specific configuration sections.
Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.
Listing presets.
GET /api/v2.0/system/presets
Every preset returns its name, which is also its identifier. Optional boolean query parameters add more fields, each defaulting to false:
| Parameter | Adds |
|---|---|
sections |
The configuration sections the preset contains |
hash |
The preset hash |
size |
The preset size in bytes |
description |
The preset description |
readonly |
Whether the preset can be modified |
details |
All of the above |
The built-in Default preset covers all sections and is read-only.
Configuration sections seen in presets are system, network, sources, edid, channels, afu, cms, avstudio, frontscreen, and displays. A preset may also record all.
Applying a preset.
POST /api/v2.0/system/presets/{pid}/control/apply
The body is optional. Supply a sections array to apply only part of the preset:
{ "sections": ["network", "channels"] }
The device may reboot. The response returns a reboot field indicating whether the device will restart to complete the apply:
{ "status": "ok", "result": { "reboot": true } }
Check this field before assuming the device stays reachable, particularly when the applied sections include network or system.
A missing preset name returns 400 with the message Missing preset name. A preset that does not exist returns 404 with a message such as Configuration preset VERYLASTCONFIG1 is not found.