Beams and presets

Mute a beam

put

Changes the mute state for a specific beam

Path parameters

beamIDstringRequired

Beam ID

Body

application/json

mutedbooleanRequired

Responses

204

No Content

400

Bad request

application/json

500

Internal server error

application/json

put

/beams/{beamID}/mute

HTTPcURLJavaScriptPython

PUT /psapi/beams/{beamID}/mute HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "muted": true
}

No content

Solo beam

put

Changes the solo state for a specific beam

Path parameters

beamIDstringRequired

Beam ID

Body

application/json

soloedbooleanRequired

Responses

204

No Content

400

Bad request

application/json

500

Internal server error

application/json

put

/beams/{beamID}/solo

HTTPcURLJavaScriptPython

PUT /psapi/beams/{beamID}/solo HTTP/1.1
Host: AAA-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "soloed": true
}

No content

Get Preset

get

Returns information for a specific preset

Path parameters

presetIDstringRequired

Preset ID

Responses

200

OK

application/json

400

Bad request

application/json

404

Preset not found

application/json

500

Internal server error

application/json

get

/presets/{presetID}

HTTPcURLJavaScriptPython

GET /psapi/presets/{presetID} HTTP/1.1
Host: AAA-1234.local
Accept: */*

{
  "beams": {
    "ANY_ADDITIONAL_PROPERTY": {
      "beam_type": "coverage-beam",
      "mute": false,
      "name": "Beam 1",
      "solo": false
    }
  },
  "name": "text"
}