Skip to content
Developers

Create a control room

POST/v2/control-rooms

POST
/v2/control-rooms
curl --request POST \
  --url https://api.ligr.live/rest/v2/control-rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "themeId": 1, "name": "example" }'

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

The theme must belong to your organization and have an active published version. A new room starts without sections or presets.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
themeId
required

Entity identifier

integer format: int32
>= 1
name
required
string
>= 1 characters <= 80 characters
Examplegenerated
{
  "themeId": 1,
  "name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
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
Examplegenerated
{
  "id": 1,
  "themeId": 1,
  "name": "example",
  "sections": [
    {
      "id": "example",
      "name": "example",
      "colorKey": "example"
    }
  ]
}

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"
}