Behavior Instance

API to manage automation instances.

List behavior instance.

get

List all available behavior instance resources.

Authorizations

hue-application-keystringRequired

Responses

200

BehaviorInstance 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/behavior_instance

GET /clip/v2/resource/behavior_instance 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",
      "script_id": "text",
      "enabled": true,
      "state": {},
      "configuration": {},
      "dependees": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "status": "initializing",
      "last_error": "text",
      "metadata": {
        "name": "text"
      }
    }
  ]
}

Get behavior instance.

get

Get details of a single behavior instance resource from its given {behaviorInstanceId}.

Authorizations

hue-application-keystringRequired

Path parameters

behaviorInstanceIdstringRequired

ID of the behavior instance

Responses

200

BehaviorInstance 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/behavior_instance/{behaviorInstanceId}

GET /clip/v2/resource/behavior_instance/{behaviorInstanceId} 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",
      "script_id": "text",
      "enabled": true,
      "state": {},
      "configuration": {},
      "dependees": [
        {
          "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
          "rtype": "device"
        }
      ],
      "status": "initializing",
      "last_error": "text",
      "metadata": {
        "name": "text"
      }
    }
  ]
}

Update behavior instance.

put

Update a single behavior instance resource from its given {behaviorInstanceId}.

Authorizations

hue-application-keystringRequired

Path parameters

behaviorInstanceIdstringRequired

ID of the behavior instance

Body

typestringOptional

Type of the supported resources (always behavior_instance here)

enabledbooleanOptional

True to enable the behavior instance.

configurationobjectOptional

Configuration for this behavior instance.

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/behavior_instance/{behaviorInstanceId}

PUT /clip/v2/resource/behavior_instance/{behaviorInstanceId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "type": "text",
  "enabled": true,
  "configuration": {},
  "metadata": {
    "name": "text"
  }
}

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