Room

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

PreviousScene NextZone

Last updated 1 year ago

Was this helpful?

Get room.

get

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

Authorizations

Path parameters

roomIdstringrequired

ID of the room

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/room/{roomId}' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

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

Room Success Response

Delete room

delete

Delete a single room from its given {roomId}

Authorizations

Path parameters

roomIdstringrequired

ID of the room

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://192.168.1.0/clip/v2/resource/room/{roomId}' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

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

Success

List rooms

get

List all available rooms

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://192.168.1.0/clip/v2/resource/room' \
  --header 'hue-application-key: YOUR_API_KEY'

200

401

403

404

405

406

409

429

500

503

507

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

Room Success Response

Create room

post

Create a new room

Authorizations

Body

typestringoptional

Type of the supported resources (always room here)

childrenobject[]optional

Child devices/services to group by the derived group

metadataobjectoptional

configuration object for a room

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://192.168.1.0/clip/v2/resource/room' \
  --header 'hue-application-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "children": [
      {
        "rid": "00afc7d2-bae5-4613-8cd8-5ba0d064a572",
        "rtype": "light"
      }
    ],
    "metadata": {
      "name": "TV Room",
      "archetype": "tv"
    }
  }'

200

401

403

404

405

406

409

429

500

503

507

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

Success

Update room

put

Update a single room from its given {roomId}

Authorizations

Path parameters

roomIdstringrequired

ID of the room

Body

typestringoptional

Type of the supported resources (always room here)

childrenobject[]optional

Child devices/services to group by the derived group

metadataobjectoptional

configuration object for a room

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://192.168.1.0/clip/v2/resource/room/{roomId}' \
  --header 'hue-application-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "text",
    "children": [
      {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      }
    ],
    "metadata": {
      "name": "text",
      "archetype": "living_room"
    }
  }'

200

401

403

404

405

406

409

429

500

503

507

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

Success

Get room.

Delete room

List rooms

Create room

Show child attributes

Show child attributes

Update room

Show child attributes

Show child attributes