Button

API to manage button services. These are offered by devices with buttons.

List buttons.

get

List all available button resources.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

Button 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/button

HTTPcURLJavaScriptPython

GET /clip/v2/resource/button 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"
      },
      "metadata": {
        "control_id": 1
      },
      "button": {
        "button_report": {
          "updated": "2026-03-31T11:36:54.205Z",
          "event": "initial_press"
        },
        "last_event": "initial_press",
        "repeat_interval": 1,
        "event_values": [
          "initial_press"
        ]
      }
    }
  ]
}

Get button.

get

Get details of a single button resource from its given {buttonId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

buttonIdstringRequired

ID of the button

Responses

200

Button 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/button/{buttonId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/button/{buttonId} 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"
      },
      "metadata": {
        "control_id": 1
      },
      "button": {
        "button_report": {
          "updated": "2026-03-31T11:36:54.205Z",
          "event": "initial_press"
        },
        "last_event": "initial_press",
        "repeat_interval": 1,
        "event_values": [
          "initial_press"
        ]
      }
    }
  ]
}

Update button.

put

Update a single button resource from its given {buttonId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

buttonIdstringRequired

ID of the button

Body

application/json

typestringOptional

Type of the supported resources (always button here)

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/button/{buttonId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/button/{buttonId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "type": "text",
  "metadata": {
    "control_id": 1
  },
  "button": {
    "repeat_interval": 1
  }
}

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