Ctrlk
GitHubHue Developer Portal
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Zone

Zones group services and each service can be part of multiple zones.

List zones

get

List all available zones

Authorizations
hue-application-keystringRequired
Responses
200

Zone Success Response

application/json
get/clip/v2/resource/zone
GET /clip/v2/resource/zone 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 zone

post

Create a new zone

Authorizations
hue-application-keystringRequired
Body
typestringOptional

Type of the supported resources (always room here)

Responses
200

Success

application/json
post/clip/v2/resource/zone
POST /clip/v2/resource/zone 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 Zone",
    "archetype": "tv"
  }
}
{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}

Get Zone.

get

Get details of a single Zone from its given {zoneId}

Authorizations
hue-application-keystringRequired
Path parameters
zoneIdstringRequired

ID of the Zone

Responses
200

Zone Success Response

application/json
get/clip/v2/resource/zone/{zoneId}
GET /clip/v2/resource/zone/{zoneId} 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 Zone

put

Update a single Zone from its given {zoneId}

Authorizations
hue-application-keystringRequired
Path parameters
zoneIdstringRequired

ID of the Zone

Body
typestringOptional

Type of the supported resources (always room here)

Responses
200

Success

application/json
put/clip/v2/resource/zone/{zoneId}
PUT /clip/v2/resource/zone/{zoneId} 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 Zone

delete

Delete a single Zone from its given {zoneId}

Authorizations
hue-application-keystringRequired
Path parameters
zoneIdstringRequired

ID of the Zone

Responses
200

Success

application/json
delete/clip/v2/resource/zone/{zoneId}
DELETE /clip/v2/resource/zone/{zoneId} 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"
    }
  ]
}

Last updated

Was this helpful?