Room

Rooms group devices and each device can only be part of one room.

List rooms

get

List all available rooms

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

Room Success Response

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get

/clip/v2/resource/room

HTTPcURLJavaScriptPython

GET /clip/v2/resource/room HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "children": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "metadata": {
        "name": "text",
        "archetype": "living_room"
      }
    }
  ]
}

Create room

post

Create a new room

Authorizations

HueApplicationKey

hue-application-keystringRequired

Body

application/json

typestringOptional

Type of the supported resources (always room here)

Responses

200

Success

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

post

/clip/v2/resource/room

HTTPcURLJavaScriptPython

POST /clip/v2/resource/room HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "children": [
    {
      "rid": "00afc7d2-bae5-4613-8cd8-5ba0d064a572",
      "rtype": "light"
    }
  ],
  "metadata": {
    "name": "TV Room",
    "archetype": "tv"
  }
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get room.

get

Get details of a single room from its given {roomId}

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

roomIdstringRequired

ID of the room

Responses

200

Room Success Response

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get

/clip/v2/resource/room/{roomId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "children": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "services": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "metadata": {
        "name": "text",
        "archetype": "living_room"
      }
    }
  ]
}

Update room

put

Update a single room from its given {roomId}

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

roomIdstringRequired

ID of the room

Body

application/json

typestringOptional

Type of the supported resources (always room here)

Responses

200

Success

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put

/clip/v2/resource/room/{roomId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "type": "text",
  "children": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ],
  "metadata": {
    "name": "text",
    "archetype": "living_room"
  }
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Delete room

delete

Delete a single room from its given {roomId}

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

roomIdstringRequired

ID of the room

Responses

200

Success

application/json

Responseall of

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

delete

/clip/v2/resource/room/{roomId}

HTTPcURLJavaScriptPython

DELETE /clip/v2/resource/room/{roomId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}