Homekit

API to manage Apple HomeKit integration.

List HomeKit.

get

List all available HomeKit resources.

Authorizations

hue-application-keystringRequired

Responses

200

Homekit 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/homekit

GET /clip/v2/resource/homekit 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"
      },
      "status": "paired",
      "action": "none"
    }
  ]
}

Get homekit.

get

Get details of a single homekit resource from its given {homekitId}.

Authorizations

hue-application-keystringRequired

Path parameters

homekitIdstringRequired

ID of the homekit

Responses

200

Homekit 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/homekit/{homekitId}

GET /clip/v2/resource/homekit/{homekitId} 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"
      },
      "status": "paired",
      "action": "none"
    }
  ]
}

Update homekit.

put

Update a single homekit resource from its given {homekitId}.

Authorizations

hue-application-keystringRequired

Path parameters

homekitIdstringRequired

ID of the homekit

Body

typestringOptional

Type of the supported resources (always homekit here)

actionstring · enumOptional

Action to trigger on the HomeKit integration.

Possible values:

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/homekit/{homekitId}

PUT /clip/v2/resource/homekit/{homekitId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "type": "text",
  "action": "homekit_reset"
}

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