Geofence Client

API to manage geofence clients.

List geofence client.

get

List all available geofence client resources.

Authorizations

hue-application-keystringRequired

Responses

200

GeofenceClient Success Response

application/json

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/geofence_client

GET /clip/v2/resource/geofence_client 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",
      "name": "text",
      "is_at_home": true
    }
  ]
}

Get geofence client.

get

Get details of a single geofence client resource from its given {geofenceClientId}.

Authorizations

hue-application-keystringRequired

Path parameters

geofenceClientIdstringRequired

ID of the geofence client

Responses

200

GeofenceClient Success Response

application/json

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/geofence_client/{geofenceClientId}

GET /clip/v2/resource/geofence_client/{geofenceClientId} 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",
      "name": "text",
      "is_at_home": true
    }
  ]
}

Update geofence client.

put

Update a single geofence client resource from its given {geofenceClientId}.

Authorizations

hue-application-keystringRequired

Path parameters

geofenceClientIdstringRequired

ID of the geofence client

Body

typestringOptional

Type of the supported resources (always geofence_client here)

namestringOptional

Name of the geofence client.

is_at_homebooleanOptional

True if the client is currently at home.

Responses

200

Success

application/json

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/geofence_client/{geofenceClientId}

PUT /clip/v2/resource/geofence_client/{geofenceClientId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "type": "text",
  "name": "text",
  "is_at_home": true
}

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