OpenHue
GitHubHue Developer Portal
  • OpenHue
  • 📗API
    • OpenHue API
      • Authentication
      • Resource
      • Bridge
      • Home
      • Device
      • Light
      • Scene
      • Room
      • Zone
      • Sensors
  • 💻CLI
    • OpenHue CLI
    • Installation
    • Setup
    • Commands
      • Lights
      • Rooms
      • Scenes
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
Export as PDF
  1. API
  2. OpenHue API

Zone

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

PreviousRoomNextSensors

Last updated 1 year ago

Was this helpful?

📗

Get Zone.

get

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

Authorizations
Path parameters
zoneIdstringRequired

ID of the Zone

Responses
200
Zone 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
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"
      }
    }
  ]
}

Delete Zone

delete

Delete a single Zone from its given {zoneId}

Authorizations
Path parameters
zoneIdstringRequired

ID of the Zone

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
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"
    }
  ]
}
  • GETList zones
  • POSTCreate zone
  • GETGet Zone.
  • PUTUpdate Zone
  • DELETEDelete Zone

List zones

get

List all available zones

Authorizations
Responses
200
Zone 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
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
Body
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
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"
    }
  ]
}

Update Zone

put

Update a single Zone from its given {zoneId}

Authorizations
Path parameters
zoneIdstringRequired

ID of the Zone

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