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

Convenience Area Motion

API to manage convenience area motion.

List convenience area motion sensors.

get

List all available convenience area motion sensors resources.

Authorizations
hue-application-keystringRequired
Responses
200

ConvenienceAreaMotion Success Response

application/json
get/clip/v2/resource/convenience_area_motion
GET /clip/v2/resource/convenience_area_motion 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",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": true,
      "motion": {
        "motion": true
      }
    }
  ]
}

Get convenience area motion.

get

Get details of a single convenience area motion resource from its given {convenienceAreaMotionId}.

Authorizations
hue-application-keystringRequired
Path parameters
convenienceAreaMotionIdstringRequired

ID of the convenience area motion

Responses
200

ConvenienceAreaMotion Success Response

application/json
get/clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId}
GET /clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId} 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",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "enabled": true,
      "motion": {
        "motion": true
      }
    }
  ]
}

Update convenience area motion.

put

Update a single convenience area motion resource from its given {convenienceAreaMotionId}.

Authorizations
hue-application-keystringRequired
Path parameters
convenienceAreaMotionIdstringRequired

ID of the convenience area motion

Body
typestringOptional

Type of the supported resources (always convenience_area_motion here)

enabledbooleanOptional

True when sensor is activated, false when deactivated.

Responses
200

Success

application/json
put/clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId}
PUT /clip/v2/resource/convenience_area_motion/{convenienceAreaMotionId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

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

Last updated

Was this helpful?