Skip to content
Developers

Get a control room

GET/v2/control-rooms/{roomId}

GET
/v2/control-rooms/{roomId}
curl --request GET \
  --url https://api.ligr.live/rest/v2/control-rooms/1 \
  --header 'Authorization: Bearer <token>'

Beta. This operation can change between minor versions. See Beta status.

Returns a room owned by your organization with its sections, its theme, and its presets. Each preset lists its graphic id, graphic name and exposed variables. When the key also has overlays:read, the response lists the overlays that use the room. Each overlay has a read-only monitoringUrl, so you can check the room without a dashboard login.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
roomId
required

Entity identifier

integer format: int32
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json

A room with everything needed to check it without a dashboard login. Fire presets with their id through the overlay control-room graphics endpoint.

object
id
required

Entity identifier

integer format: int32
>= 1
themeId
required

Entity identifier

integer format: int32
>= 1
name
required
string
sections
required
Array<object>
object
id
required
string
name
required
string
colorKey
string
theme
required
object
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
activeVersion
required

Published theme version that overlays render, or null before activation.

integer format: int32
nullable
presets
required
Array<object>
object
id
required

Entity identifier

integer format: int32
>= 1
controlRoomId
required

Entity identifier

integer format: int32
>= 1
sectionId
required
string
graphicId
required
string
name
required
string
orderIndex
required
integer format: int32
variableValues
required

Scalar and enum overrides keyed by names in the active published graphic manifest.

object
key
additional properties
Any of:
string
exposedVariables
required

Every control variable operators can see on this preset, with or without a stored value.

Array<string>
graphicName

Name of the preset’s graphic in the theme. Absent when the graphic was deleted from the theme.

string
overlays

Overlays that use this room, each with its read-only monitoringUrl. Present only when the key has the overlays:read scope.

Array<object>
object
name
required
string
>= 1 characters <= 35 characters
id
required

Entity identifier

integer format: int32
>= 1
matchId

Entity identifier

integer format: int32
>= 1
encodingDelay

Seconds to delay graphic updates

integer format: int32
<= 120
key
required

Stringified UUIDv4. See RFC 4112

string
/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}/
autoMode
boolean
adType
string
competitionThemeSettingId
integer format: int32
nullable >= 1
controlRoomId
integer format: int32
nullable >= 1
controlRoomUrl

Open this URL with an authenticated dashboard session after setup.

string
monitoringUrl

Read-only monitoring page of this overlay on the overlay host of this environment. Open it to see the graphics that are on air. It does not take control of the overlay.

string
Example
{
  "overlays": [
    {
      "matchId": 703,
      "id": 2300003,
      "name": "Overlay 1",
      "encodingDelay": 6,
      "key": "3b2bbcc8-0544-4edb-b847-8179ba026086"
    }
  ]
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Theme, control room, section, or graphic not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}