Relative Rotary

API to manage relative rotary controls.

List relative rotary controls.

get

List all available relative rotary resources.

Authorizations

hue-application-keystringRequired

Responses

200

RelativeRotary 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/relative_rotary

GET /clip/v2/resource/relative_rotary 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
      },
      "relative_rotary": {
        "rotary_report": {
          "updated": "2026-01-01T00:00:00.000Z",
          "action": "start",
          "rotation": {
            "direction": "clock_wise",
            "steps": 1,
            "duration": 1
          }
        },
        "last_event": {
          "action": "start",
          "rotation": {
            "direction": "clock_wise",
            "steps": 1,
            "duration": 1
          }
        }
      }
    }
  ]
}

Get relative rotary.

get

Get details of a single relative rotary resource from its given {relativeRotaryId}.

Authorizations

hue-application-keystringRequired

Path parameters

relativeRotaryIdstringRequired

ID of the relative rotary

Responses

200

RelativeRotary 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/relative_rotary/{relativeRotaryId}

GET /clip/v2/resource/relative_rotary/{relativeRotaryId} 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
      },
      "relative_rotary": {
        "rotary_report": {
          "updated": "2026-01-01T00:00:00.000Z",
          "action": "start",
          "rotation": {
            "direction": "clock_wise",
            "steps": 1,
            "duration": 1
          }
        },
        "last_event": {
          "action": "start",
          "rotation": {
            "direction": "clock_wise",
            "steps": 1,
            "duration": 1
          }
        }
      }
    }
  ]
}

Update relative rotary.

put

Update a single relative rotary resource from its given {relativeRotaryId}.

Authorizations

hue-application-keystringRequired

Path parameters

relativeRotaryIdstringRequired

ID of the relative rotary

Body

typestringOptional

Type of the supported resources (always relative_rotary 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/relative_rotary/{relativeRotaryId}

PUT /clip/v2/resource/relative_rotary/{relativeRotaryId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "type": "text"
}

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