Philips Hue Docs

api-core-concepts.md

Core Concepts

The hue system is built around the idea of everything in your system having a unique URL served by the bridge. Interacting with these URLs lets you modify them or find out their current state.

Hue Web Addresses

A hue resource web address for the V2 API will typically start with the following.

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

https:///clip/v2

https:///clip/v2

https:///clip/v2

This is the RESTful root and is how your app or controller talks to the Hue Bridge interface.

Hue Application Key

In most of the commands (the exceptions are creating a key and getting basic bridge information) you’ll include a hue-application-key in the header:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

GET /clip/v2 HTTP/2

Host: <bridge IP address>:443

hue-application-key: <appkey>

GET /clip/v2 HTTP/2 Host: :443 hue-application-key:

GET /clip/v2 HTTP/2 Host: :443 hue-application-key:

This application key determines which resources you have access to. If you provide an application key that isn’t known to the bridge then most resources won’t be available to you. Using one that is authorized, as shown in the getting started section, will allow you to interact with pretty much everything interesting.

Each new instance of an app should use a unique application key which you generate using the Create New User command.

Resources

There are many different kinds of resources to interact with. The top 3 most used ones are:

/resource/device resource which contains all devices connected to the bridge (and the bridge itself)
/resource/light resource which contains all light services
/resource/room resource which contains all rooms

The list of all resources is available in the API reference.

You can query resources available in your bridge by doing a GET on its local URL. For example the following returns all devices in your bridge.

Address	https://<bridge IP address>/clip/v2/resource/device
Method	GET
Header	hue-application-key: <appkey>

Change a Resource

The principle for changing a resource is to send a PUT request to the URL of that specific resource. The desired new value is attached to the request in the Message Body in JSON format.

For example to change the name of a device we address the device resource by its id (/resource/device/<id>) and send the new name with the request in the message body.

Address	https://<bridge IP address>/clip/v2/device/<id>
Method	PUT
Header	hue-application-key: <appkey>
Body	{"metadata": {"name": "developer lamp"}}

If you’re doing something that isn’t allowed, maybe setting a value out of range or typo in the resource name, then you’ll get a 4xx HTTP status code and an error message letting you know what’s wrong.

Service references

Each device in the Hue System typically offers a set of services. For example a light service, a connectivity service, or a motion sensing services. Each of these services have their own resource which will be referenced via the resource type rtype and resource id rid. This way you can link to those services to read or modify their state. For example, to address the light service of the example device below, the path would be /resource/light/c6b028c8-076e-4817-92b1-bcb0cbb78783

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

{

"type": "device",

"id": "7b839dff-c2d2-4f90-9509-fea4b461b30d",

"metadata": {

"archetype": "sultan_bulb",

"name": "User given name"

},

"product_data": {

"manufacturer_name": "Signify Netherlands B.V.",

"model_id": "XXX001",

"product_name": "Fixed product name",

"software_version": "x.y.z"

},

"services": [

{

"rid": "c6b028c8-076e-4817-92b1-bcb0cbb78783",

"rtype": "light"

},

{

"rid": "6ec5432f-fb66-4b07-88de-bb0087a0e33d",

"rtype": "zigbee_connectivity"

}

]

}

{ "type": "device", "id": "7b839dff-c2d2-4f90-9509-fea4b461b30d", "metadata": { "archetype": "sultan_bulb", "name": "User given name" }, "product_data": { "manufacturer_name": "Signify Netherlands B.V.", "model_id": "XXX001", "product_name": "Fixed product name", "software_version": "x.y.z" }, "services": [ { "rid": "c6b028c8-076e-4817-92b1-bcb0cbb78783", "rtype": "light" }, { "rid": "6ec5432f-fb66-4b07-88de-bb0087a0e33d", "rtype": "zigbee_connectivity" } ] }

{ "type": "device", "id": "7b839dff-c2d2-4f90-9509-fea4b461b30d", "metadata": { "archetype": "sultan_bulb", "name": "User given name" }, "product_data": { "manufacturer_name": "Signify Netherlands B.V.", "model_id": "XXX001", "product_name": "Fixed product name", "software_version": "x.y.z" }, "services": [ { "rid": "c6b028c8-076e-4817-92b1-bcb0cbb78783", "rtype": "light" }, { "rid": "6ec5432f-fb66-4b07-88de-bb0087a0e33d", "rtype": "zigbee_connectivity" } ] }

Controlling Light

There are multiple light features that can be controlled with Hue. These features are in sub-objects of the light service. Let’s go through them and explain.

The Easy Ones

on – This is the easiest example. A light can be on or off. So setting this value to true turns a light on to its last setting {"on": {"on": true}}. Setting the value to false turns the light off.

dimming – This is about controlling brightness of a light. We use the brightness in % (note minimum brightness is not off). The range has been calibrated so there are perceptually similar steps in brightness over the range. You can set the “brightness” key in the “dimming” object to a specific value, e.g. the following command sets the light to 50% of its maximum brightness.

Address	https://<bridge IP address>/clip/v2/resource/light/<id>
Method	PUT
Header	hue-application-key: <appkey>
Body	{"dimming": {"brightness": 50}}

Colors Get More Complicated

The color point of light has lots of ways of being quantified. The diagram below shows a plot of what is known as the CIE color space – the 3 triangles outline the colors which Hue can address.

All points on this plot have unique xy coordinates that can be used when setting the color of a Hue bulb. If an xy value outside of bulbs relevant Gamut triangle is chosen, it will produce the closest color it can make. To control lights with xy use the “xy” sub-object within the “color” object which takes an x and y values between 0 and 1 e.g. {"color": {"xy": {"x":0.675, "y":0.322}}} is red.

We can also choose to address the color point of light in a different way, using colors on the black curved line in the center of the diagram. This is the line that follows white colors from a warm white to a cold white. Hue supports color temperatures from 2000K (warm) to 6500K (cold) with high quality white light. To set the light to a white value you need to interact with the “color_temperature” object, which takes values in a scale called “reciprocal megakelvin” or “mirek”. Using this scale, the warmest color 2000K is 500 mirek {"color_temperature": {"mirek": 500}} and the coldest color 6500K is 153 mirek. As with xy, the light will go to the closest value it can produce if the specified color temperature is outside of the achievable range.

An important note is that availability of the feature objects depends on device capabilities. So for example a light that has no color capabilities, will not have the color feature object.

Representations

The Hue system is built on the principle of representations. Each object in the Hue system has a corresponding resource in the Hue interface (a representation of the real object). You interact directly with these representations and afterwards the necessary Zigbee commands are sent out to lights to effect the change.

This lets us do things fast without worrying about the wireless messages bouncing between the lights, but it can mean that things are temporarily inconsistent. By this we mean the state of the lights and the state of their representation are not the same for a short period. It corrects itself after a while, but for example if you set all your lights to red and then power cycle a light so that it goes to white, it could take a few minutes for the bridge to update its representation.

Rooms

A user can have a lot of devices in their home. To organize them, we typically list devices per room, as each device can only be part of one room. By now it will probably be clear that retrieving the list of rooms can be done by a GET on /resource/room. This shows the id and name of each room, with the array of “children” referring to the devices in the room. Referencing the devices uses the same universal method as we’ve seen before with services i.e. using “rid” and “rtype”. As you can see in the example below the room itself also offers a “grouped_light” service. This can be used to control the lights as a group, in a similar way as controlling an individual light.

Example representation of a room:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

{

"type": "room",

"id": "708d8a89-5d05-408f-b43c-830fbff8316e",

"metadata": {

"archetype": "living_room",

"name": "Living room"

},

"children": [

{

"rid": "a91cde76-1d98-400c-873d-12f241f26145",

"rtype": "device"

},

{

"rid": "25f1f7e4-e409-4b64-a1d7-8186916de2d6",

"rtype": "device"

}

],

"services": [

{

"rid": "27a6cc29-57e3-4e3e-b83d-f9cc33cc9629",

"rtype": "grouped_light"

}

]

}

{ "type": "room", "id": "708d8a89-5d05-408f-b43c-830fbff8316e", "metadata": { "archetype": "living_room", "name": "Living room" }, "children": [ { "rid": "a91cde76-1d98-400c-873d-12f241f26145", "rtype": "device" }, { "rid": "25f1f7e4-e409-4b64-a1d7-8186916de2d6", "rtype": "device" } ], "services": [ { "rid": "27a6cc29-57e3-4e3e-b83d-f9cc33cc9629", "rtype": "grouped_light" } ] }

{ "type": "room", "id": "708d8a89-5d05-408f-b43c-830fbff8316e", "metadata": { "archetype": "living_room", "name": "Living room" }, "children": [ { "rid": "a91cde76-1d98-400c-873d-12f241f26145", "rtype": "device" }, { "rid": "25f1f7e4-e409-4b64-a1d7-8186916de2d6", "rtype": "device" } ], "services": [ { "rid": "27a6cc29-57e3-4e3e-b83d-f9cc33cc9629", "rtype": "grouped_light" } ] }

Limitations

With these commands you can control any number of your lights in any way you want, just address the correct light resource and send it the command you want.

We have some limitations to bear in mind:

We can’t send commands to the lights too fast. If you stick to around 10 commands per second to the /light resource as maximum you should be fine. For /grouped_light commands you should keep to a maximum of 1 per second. The REST API should not be used to send a continuous stream of fast light updates for an extended period of time, for that use case you should use the dedicated Hue Entertainment Streaming API.

If you try and control multiple conflicting parameters at once e.g. {"color": {"xy": {"x":0.5,"y":0.5}}, "color_temperature": {"mirek": 250}} the lights can only physically do one, for this we apply the rule that xy beats ct. Simple.

All your lights have to be in range of the bridge. If you can control them from the Hue app then you’re fine to play with them via the API. Remember all lights act as a signal repeater so if you want more range put a light in between.

Events

As we have seen, you need to use a GET request to retrieve the state of resources when you first connect to the Hue Bridge. However, while you are connected, other applications and control methods can modify the state of those resources as well. It is important to not try to stay up to date by performing repeated GET requests, as that is bad for the performance of the system and generally gives a laggy user experience. Instead, you can subscribe to retrieving proactive event notifications immediately when something changes. This can be done by leveraging ‘Server-Sent Events’ (SSE) under the /eventstream endpoint:

curl --insecure -N -H 'hue-application-key: <appkey>' -H 'Accept: text/event-stream' https://<ipaddress>/eventstream/clip/v2

Events have an id, timestamp, type (‘update’, ‘add’, ‘delete’, ‘error’), and data field which contains the changed properties of the resource in the same format as a GET response on the same resource type, but with all properties optional as each event only includes the properties that changed. The following is an example event stream that would result from turning a light on and off:

id: 1634576695:0
data: [{"creationtime":"2021-10-18T17:04:55Z","data":[{"id":"e706416a-8c92-46ef-8589-3453f3235b13","on":{"on":true},"owner":{"rid":"3f4ac4e9-d67a-4dbd-8a16-5ea7e373f281","rtype":"device"},"type":"light"}],"id":"9de116fc-5fd2-4b74-8414-0f30cb2cbe04","type":"update"}]

id: 1634576699:0
data: [{"creationtime":"2021-10-18T17:04:59Z","data":[{"id":"e706416a-8c92-46ef-8589-3453f3235b13","on":{"on":false},"owner":{"rid":"3f4ac4e9-d67a-4dbd-8a16-5ea7e373f281","rtype":"device"},"type":"light"}],"id":"5ebb24e4-0563-43e2-8e8e-c10fc4f0095f","type":"update"}]

On HTTP1.1, you will need a separate connection for the SSE request and regular requests, but we recommend using HTTP2 to multiplex them over a single connection which is more resource efficient.

There is a 1 second rate limit on the amount of event containers the Bridge will send. If the same property has changed twice within that timeframe, you only get the last state. If multiple resources have changed within that timeframe, then you will get multiple events grouped in a single container.

More

There’s a lot more to the Hue System, for example:

• Zones are a way of grouping just like rooms, but they group services rather than devices, and have no restrictions i.e. services can be part of multiple zones
• Scenes are a way of creating preset light settings for all lights within a room or zone, which can then be easily recalled later
• Sensor services like “motion”, “light_level” and “temperature” can indicate information about the environment
• Button service can be used to receive an event when a user presses a button on one of our button/switch devices
• Entertainment configurations enable fast changing position based light effects for Hue Entertainment use cases
• Behaviors are used to create and configure automations in the Hue System, however this is under development and at this moment you can only list behaviors

They all follow many of the same core concepts you have just learned about, so have fun exploring our full API Reference!

api-getting-started.md

Getting started

The fastest way to learn how to build apps which control the hue system is to use a simple API testing tool. This lets you directly input commands and send them to the lights. In this article we'll use Postman, but any HTTP client should work.

Follow 3 Easy Steps

Step 1

First make sure your bridge is connected to your network and is functioning properly. Test that the official Philips Hue mobile app can control the lights on the same network.

Step 2

Then you need to discover the IP address of the bridge on your network. You can do this in a few ways.

NOTE – When you are ready to make a production app, you need to discover the bridge automatically using Hue Bridge Discovery Guide.

1. Go to the settings menu in the app. Go to Hue Bridges. Select your bridge. The ip address of the bridge will show.
2. Use an mDNS discovery app to find Philips hue in your network.
3. Use our broker server discover process by visiting https://discovery.meethue.com
4. Log into your wireless router and look Philips hue up in the DHCP table.

Step 3

Download, install, and open the Postman tool (or any other API testing tool to your liking) and disable ‘SSL certificate verification’ in File – Settings menu.

NOTE – When you are ready to make a production app, you need to properly validate the certificate, see Using HTTPS.

Using an API testing tool you can populate the components of an HTTPS request – the basis of all web traffic and of the hue API.

1. URL: this is actually the local address of a specific resource (thing) inside the hue system. It could be device, light, room, scene or many more things. This is the object you’ll be interacting with in this command.

2. Request method: here you have a choice of the 4 HTTPS methods the hue system uses.
GET: this is the command to fetch all information about the addressed resource
PUT: this is the command to modify an addressed resource
POST: this is the command to create a new resource inside the addressed resource
DELETE: this is the command to delete the addressed resource

3. Request body: this is the part of the message which describes what you want to change and how. Here you enter, in JSON format, the resource name and value you’d like to change/add.

4. Response code: This will indicate whether your request succeeded or failed.

5. Response body: Here you’ll see the response to your command. Also in JSON format.

So let’s get started…

First let’s do a very simple request and get information about the devices in your hue system.

Fill in the details below leaving the body empty and press the Send button.

URL	https://<bridge ip address>/clip/v2/resource/device
Method	GET

Make sure you are on the same network as the bridge, and that you use the ip you obtained in step 2. Now you should see the response code 403 Forbidden:

That’s because we did not yet provide a hue-application-key header for authorization.

We need to use the randomly generated application key that the bridge creates for you. Fill in the info below and press the Send button.

URL	https://<bridge ip address>/api
Body	{"devicetype":"app_name#instance_name", "generateclientkey":true}
Method	POST

You should get back an error message letting you know that you have to press the link button.

This is our security step so that only apps you want to control your lights can. By pressing the button we prove that the user has physical access to the bridge.

Go and press the button on the bridge and then press the Send button again and you should get a success response like below.

You’ve now created an authorized username, which we’ll use as the hue-application-key from now on.

Retrieving device list

In the Headers section you should add a header with name hue-application-key and value the username (sFlEGnMAFXO6RtZV17aViNUB95G2uXWw64texDzD in above example). From here on we will refer to this username as appkey. Now if you do the first GET request again you should get a 200 OK response code with a whole lot of information about what devices you have and what services they offer in the response body. This data is all in JSON format so can be easily processed by your applications.

Address	https://<bridge ip address>/clip/v2/resource/device
Method	GET
Header	hue-application-key: <appkey>

Congratulations you’ve just sent you first authorized CLIP command!

Controlling a light

Okay now that we have a hue-application-key with permission to use the system lets start having some fun.

You should see that most Hue devices offer a light service. Each light service has its own URL, which you can construct using the “rtype” and “rid” of the service. Let’s get information about the light service with rid fc2daa74-0d44-4712-a373-e39a9c2b426d by filling that in the id part of the address below. In your case you need to take the rid of the light service reported by your device.

Address	https://<bridge ip address>/clip/v2/resource/light/<id>
Method	GET
Header	hue-application-key: <appkey>

In this response you can see all of the properties this light service has. The most interesting ones are the feature objects on, dimming, color_temperature, and color. These are the ones we’ll use to control the light.

Let’s start with the “on” object. This is a very simple object with an on attribute that can have 2 values: true and false. So let’s try turning the light off.

Address	https://<bridge ip address>/clip/v2/resource/light/<id>
Method	PUT
Header	hue-application-key: <appkey>
Body	{"on":{"on":false}}

Looking at the command you are sending we’re addressing the “on” object of the light service and telling it to modify the “on” value inside it to false (i.e. off). When you press the Send button the light should turn off.

Change the value in the body to true and after pressing Send the light will turn on again.

Now let’s do something a bit more fun and start changing some colors. Enter the command below.

Address	https://<bridge ip address>/clip/v2/resource/light/<id>
Method	PUT
Header	hue-application-key: <appkey>
Body	{"dimming":{"brightness":50.0},"color":{"xy":{"x":0.4605,"y":0.2255}}}

Now we’re modifying a couple more attributes to set the brightness to 50% and the color to purple at the same time.

The x and y values for color vary between 0 and 1. Try changing the values and keep pressing the Send button and see the color of your light changing. You can use this image to see what values correspond to which colors.

There is also an eventing mechanism to automatically receive changes to resources but more on this later.

Now you understand the basics of the commands you can send to hue through an API testing tool – but we can also send the commands as part of an app.  Intrigued now? Read more at Core Concepts.

Color Conversion Formulas RGB to XY and back.md

Color Conversion Formulas RGB to XY and back

This document describes the conversion between RGB and xy. It is important to differentiate between the various light types, because they do not all support the same color gamut. For example, the hue bulbs are very good at showing nice whites, while the LivingColors are generally a bit better at colors, like green and cyan. For more info, check out the supported lights page.

Gamut

The colors of Hue lights are controlled by xy values in the CIE color space. Since this is a well defined color space that is independent of the gamut of any specific light, we know for sure that the same xy value always result in the same color, regardless of the type of light used (as long as the color is within the gamut of the light).
Current Philips Hue lights have a color gamut defined by 3 points, making it a triangle. The 3 triangles outline the colors which Hue can address.

For all newer model Hue lights (Gamut C) the corners of the triangle are

Red: 0.6915, 0.3038 Green: 0.17, 0.7 Blue: 0.1532, 0.0475

For the older model hue bulb (Gamut B) the corners of the triangle are

Red: 0.675, 0.322 Green: 0.409, 0.518 Blue: 0.167, 0.04

For legacy LivingColors Bloom, Aura, Light Strips and Iris (Gamut A) the triangle corners are:
Red: 0.704, 0.296 Green: 0.2151, 0.7106 Blue: 0.138, 0.08

If you have light which is not one of those, you should use:
Red: 1.0, 0 Green: 0.0, 1.0 Blue: 0.0, 0.0

The Hue API V2 exposes these gamuts on the API for each light resource, so you don’t need to hardcode them. If you have a color defined in RGB that you want to set the Hue lights to, then you need to convert it to xy. The next section outlines how to do that.

RGB to xy

We start with the color to xy conversion, which we will do in a couple of steps:

1. Get the RGB values from your color object and convert them to be between 0 and 1. So the RGB color (255, 0, 100) becomes (1.0, 0.0, 0.39)

2. Apply a gamma correction to the RGB values, which makes the color more vivid and more the like the color displayed on the screen of your device.

This gamma correction is also applied to the screen of your computer or phone, thus we need this to create a similar color on the light as on screen. This is done by the following formulas:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float red = (red > 0.04045f) ? pow((red + 0.055f) / (1.0f + 0.055f), 2.4f) : (red / 12.92f);

float green = (green > 0.04045f) ? pow((green + 0.055f) / (1.0f + 0.055f), 2.4f) : (green / 12.92f);

float blue = (blue > 0.04045f) ? pow((blue + 0.055f) / (1.0f + 0.055f), 2.4f) : (blue / 12.92f);

float red = (red > 0.04045f) ? pow((red + 0.055f) / (1.0f + 0.055f), 2.4f) : (red / 12.92f); float green = (green > 0.04045f) ? pow((green + 0.055f) / (1.0f + 0.055f), 2.4f) : (green / 12.92f); float blue = (blue > 0.04045f) ? pow((blue + 0.055f) / (1.0f + 0.055f), 2.4f) : (blue / 12.92f);

float red = (red > 0.04045f) ? pow((red + 0.055f) / (1.0f + 0.055f), 2.4f) : (red / 12.92f); float green = (green > 0.04045f) ? pow((green + 0.055f) / (1.0f + 0.055f), 2.4f) : (green / 12.92f); float blue = (blue > 0.04045f) ? pow((blue + 0.055f) / (1.0f + 0.055f), 2.4f) : (blue / 12.92f);

3. Convert the RGB values to XYZ using the Wide RGB D65 conversion formula The formulas used:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float X = red * 0.4124 + green * 0.3576 + blue * 0.1805;

float Y = red * 0.2126 + green * 0.7152 + blue * 0.0722;

float Z = red * 0.0193 + green * 0.1192 + blue * 0.9505;

float X = red * 0.4124 + green * 0.3576 + blue * 0.1805; float Y = red * 0.2126 + green * 0.7152 + blue * 0.0722; float Z = red * 0.0193 + green * 0.1192 + blue * 0.9505;

float X = red * 0.4124 + green * 0.3576 + blue * 0.1805; float Y = red * 0.2126 + green * 0.7152 + blue * 0.0722; float Z = red * 0.0193 + green * 0.1192 + blue * 0.9505;

4. Calculate the xy values from the XYZ values

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float x = X / (X + Y + Z);

float y = Y / (X + Y + Z);

float brightness = Y;

float x = X / (X + Y + Z); float y = Y / (X + Y + Z); float brightness = Y;

float x = X / (X + Y + Z); float y = Y / (X + Y + Z); float brightness = Y;

5. Check if the found xy value is within the color gamut of the light, if not continue with step 6, otherwise step 7 When we send a value which the light is not capable of, the resulting color might not be optimal. Therefore we try to only send values which are inside the color gamut of the selected light.

6. Calculate the closest point on the color gamut triangle and use that as xy value The closest value is calculated by making a perpendicular line to one of the lines the triangle consists of and when it is then still not inside the triangle, we choose the closest corner point of the triangle.

7. Use the Y value of XYZ as brightness The Y value indicates the brightness of the converted color.

xy to RGB

The xy to color conversion is almost the same, but in reverse order.

1. Check if the xy value is within the color gamut of the lamp, if not continue with step 2, otherwise step 3 We do this to calculate the most accurate color the given light can actually do.

2. Calculate the closest point on the color gamut triangle and use that as xy value See step 6 of color to xy.

3. Calculate XYZ values Convert using the following formulas:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float x = x; // the given x value

float y = y; // the given y value

float z = 1.0f - x - y;

float Y = brightness; // The given brightness value

float X = (Y / y) * x;

float Z = (Y / y) * z;

float x = x; // the given x value float y = y; // the given y value float z = 1.0f - x - y; float Y = brightness; // The given brightness value float X = (Y / y) * x; float Z = (Y / y) * z;

float x = x; // the given x value float y = y; // the given y value float z = 1.0f - x - y; float Y = brightness; // The given brightness value float X = (Y / y) * x; float Z = (Y / y) * z;

4. Convert to RGB using Wide RGB D65 conversion

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float r = X * 1.656492f - Y * 0.354851f - Z * 0.255038f;

float g = -X * 0.707196f + Y * 1.655397f + Z * 0.036152f;

float b = X * 0.051713f - Y * 0.121364f + Z * 1.011530f;

float r = X * 1.656492f - Y * 0.354851f - Z * 0.255038f; float g = -X * 0.707196f + Y * 1.655397f + Z * 0.036152f; float b = X * 0.051713f - Y * 0.121364f + Z * 1.011530f;

float r = X * 1.656492f - Y * 0.354851f - Z * 0.255038f; float g = -X * 0.707196f + Y * 1.655397f + Z * 0.036152f; float b = X * 0.051713f - Y * 0.121364f + Z * 1.011530f;

5. Apply reverse gamma correction

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

r = r <= 0.0031308f ? 12.92f * r : (1.0f + 0.055f) * pow(r, (1.0f / 2.4f)) - 0.055f;

g = g <= 0.0031308f ? 12.92f * g : (1.0f + 0.055f) * pow(g, (1.0f / 2.4f)) - 0.055f;

b = b <= 0.0031308f ? 12.92f * b : (1.0f + 0.055f) * pow(b, (1.0f / 2.4f)) - 0.055f;

r = r <= 0.0031308f ? 12.92f * r : (1.0f + 0.055f) * pow(r, (1.0f / 2.4f)) - 0.055f; g = g <= 0.0031308f ? 12.92f * g : (1.0f + 0.055f) * pow(g, (1.0f / 2.4f)) - 0.055f; b = b <= 0.0031308f ? 12.92f * b : (1.0f + 0.055f) * pow(b, (1.0f / 2.4f)) - 0.055f;

r = r <= 0.0031308f ? 12.92f * r : (1.0f + 0.055f) * pow(r, (1.0f / 2.4f)) - 0.055f; g = g <= 0.0031308f ? 12.92f * g : (1.0f + 0.055f) * pow(g, (1.0f / 2.4f)) - 0.055f; b = b <= 0.0031308f ? 12.92f * b : (1.0f + 0.055f) * pow(b, (1.0f / 2.4f)) - 0.055f;

6. Convert the RGB values to your color object

The rgb values from the above formulas are between 0.0 and 1.0.

HSV to RGB

But what if you have a color defined in HSV (Hue/Saturation/Brightness) instead of RGB or xy? Well then we can first convert from HSV to RGB, and then from RGB to xy. In this case we assume that Hue is between 0 and 360 degrees, and saturation and brightness between 0 and 100%.

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

float s = S/100;

float v = V/100;

float C = s*v;

float X = C*(1-fabs(fmod(H/60.0, 2)-1));

float m = v-C;

float r,g,b;

if(H >= 0 && H < 60){

r = C, g = X, b = 0;

}

else if(H >= 60 && H < 120){

r = X, g = C, b = 0;

}

else if(H >= 120 && H < 180){

r = 0, g = C, b = X;

}

else if(H >= 180 && H < 240){

r = 0, g = X, b = C;

}

else if(H >= 240 && H < 300){

r = X, g = 0, b = C;

}

else{

r = C, g = 0, b = X;

}

int R = r+m;

int G = g+m;

int B = b+m;

float s = S/100; float v = V/100; float C = s*v; float X = C*(1-fabs(fmod(H/60.0, 2)-1)); float m = v-C; float r,g,b; if(H >= 0 && H < 60){ r = C, g = X, b = 0; } else if(H >= 60 && H < 120){ r = X, g = C, b = 0; } else if(H >= 120 && H < 180){ r = 0, g = C, b = X; } else if(H >= 180 && H < 240){ r = 0, g = X, b = C; } else if(H >= 240 && H < 300){ r = X, g = 0, b = C; } else{ r = C, g = 0, b = X; } int R = r+m; int G = g+m; int B = b+m;

float s = S/100;
float v = V/100;
float C = s\*v;
float X = C\*(1-fabs(fmod(H/60.0, 2)-1));
float m = v-C;
float r,g,b;
if(H >= 0 && H < 60){
    r = C, g = X, b = 0;
}
else if(H >= 60 && H < 120){
    r = X, g = C, b = 0;
}
else if(H >= 120 && H < 180){
    r = 0, g = C, b = X;
}
else if(H >= 180 && H < 240){
    r = 0, g = X, b = C;
}
else if(H >= 240 && H < 300){
    r = X, g = 0, b = C;
}
else{
    r = C, g = 0, b = X;
}
int R = r+m;
int G = g+m;
int B = b+m;

The resulting RGB values are already between 0 and 1, so from here you can start with step 2 of the RGB to xy section.

Hue System Performance.md

Hue System Performance

This note describes some aspects of the performance of the hue system for light control. These can be used by the application designer to optimally use the hue system without overloading it. The reader of this document is expected to be familiar with the Philips hue API description and usage. The Philips hue API is a RESTful interface over HTTPS for controlling the hue lights.

It is strongly advised to send less commands than the maximum indicated in this note, otherwise the ZigBee network of the hue system may not function correctly with other commands on the network, e.g. hue Tap. For any feature where you need to send fast light updates for an extended period of time, you must use the dedicated Hue Entertainment Streaming API.

Aspects of System Performance

In this note, the following aspects of the hue system performance will be discussed:

System latency:

This is the time between sending a hue API command to the bridge and completion of the light effect on the lamp, e.g. setting a lamp to certain brightness and color when transitiontime=0 is used.

System throughput:

This is the number of light effects per second that can be handled by the hue bridge (and the rest of the system).

Also, some special situations will be discussed, in which the performance of the system can deviate from the normal latency and throughput behavior.

System Latency

Using the CLIP interface, an application can dispatch light commands into the bridge. The bridge will translate these commands into (one or more) corresponding ZigBee message(s). These messages will be transmitted over the ZigBee network; the lamp(s) will receive these message(s), and update their light state(s). The system latency is defined as the time between sending a hue API command (CLIP command in image) to the bridge and completion of the light effect on the lamp, e.g. setting a lamp to certain brightness and color – when using parameter transitiontime=0 (i.e. immediate transition).

Table 1 below summarizes the system latency that one can expect. As obvious from the table, this latency depends on the number of ZigBee messages that result out of the hue API command – details of this translation will be discussed in the Translation of hue API commands section below. The system latencies listed in Table 1 have been measured under the following conditions:

• he hue API command is controlling a single lamp (unicast message)
• The lamp is already on
• The parameter transitiontime is set to 0
• The lamp can be reached via a single ZigBee hop
• A wired Ethernet connection is used between PC or app and router and between router and hue bridge (being independent of Wifi latencies)
• There is no background ZigBee traffic (such as software download)
• The maximum system throughput rate from the System Throughput section is respected

The values in the table are averages from a series of measurements; variations of about +/-5 ms are typical.

Table 1: Average latency for various hue API messages

#ZigBee messages per hue API command	parameters used in body of hue API command (example)	average latency
1	brightness	55 ms
2	brightness + color	95 ms
3	brightness + color + on	125 ms

Translation of Hue API Commands to ZigBee Messages

The bridge has to translate the set of parameters in the hue API command into one or more ZigBee messages; Table 1 above summarizes the number of ZigBee messages that are transmitted by the bridge as result of the parameters used in a single hue API command. As an example, a hue API command with “bri” and “sat” parameters, will be translated into 2 ZigBee messages.

As a consequence, for optimal performance, the application should not send superfluous parameters in a hue API command, e.g. there is no need to include an “on” parameter in the hue API command when a lamp is already (known to be) on, and no need to include a “bri” parameter when only the color of a lamp needs to be updated.

Table 2: Translation of hue API commands to ZigBee messages

Parameters used in body of hue API command	#ZigBee messages
bri	1
hue	1
sat	1
xy	1
ct	1
on	1
transitiontime	02
bri + xy	2
bri + xy + on	3
bri + hue	2
bri + sat	2
bri + hue + sat	2
bri + hue + sat + on	3
bri + ct	2
bri + ct + on	3

System Throughput

Hue API commands are dispatched by an application into the bridge. The bridge will translate these into corresponding ZigBee message(s), and transmit those. In this process, the bridge will take into account the known throughput of the various parts of the system, and maximum allowed ZigBee messages indicated in the ZigBee standard, and will schedule messages for ZigBee transmission at a corresponding rate (“throttling” to prevent overloading the ZigBee network). Apart from the ZigBee messages resulting from the CLIP commands sent by your application, other ZigBee messages are also sent and received by the bridge (e.g. scene setting due to hue tap switch, system housekeeping, software download, ..).

The throttling takes into account the combined system load of these messages of various sources. The available system throughput (from the hue API) is thus restricted by the number of ZigBee messages per second that can be handled by the system, which is approximately 25 ZigBee messages/s. Depending on the number of ZigBee messages that result from a hue API command, the throughput (in hue API commands/s) and time between consecutive hue API commands as illustrated in Table 3 can be derived.

Table 3: Throughput for various hue API commands

#ZigBee messages per hue API command	Parameters used in body of hue API command (example)	System throughput	Time between hue API messages
1	setting brightness	brightness	40 ms
1	setting brightness+color	25 hue API commands/s	80 ms
3	setting brightness + color+on	2 hue API commands/s	120 ms

As soon as an application exceeds these rates, buffering will occur in the bridge, which will significantly increase the latency for following commands. Therefore, exceeding these rates should be avoided.

Special Situations

In certain situations, the performance of the system can deviate from the latency and throughput mentioned in the previous sections. This section will discuss some situations, and provide tips how to avoid them.

Clogging

As indicated in the System Throughput section, sending hue API commands at a rate exceeding the throughput limit will cause the commands to be piled up inside the bridge (“buffering”), leading to considerable latency increase. Worst case this can be several seconds.

When exceeding the throughput limit (and hence buffering occurring), there is no direct indication to the application that buffering is occurring – so (initially) the application is unaware of the buffering, and the latency will be significantly larger than described above. When the application continues to send at such a rate exceeding the capabilities of the system, after some time the buffer in bridge will become full, and the hue API command will be dropped, and an error similar to this one is reported in the reply to the hue API command that got dropped:

Plain text

Copy to clipboard

Open code in new window

EnlighterJS 3 Syntax Highlighter

{

"error":{

"type":901,

"address":"/lights/1/state",

"description":"Internal error, 503"

}

}

{ "error":{ "type":901, "address":"/lights/1/state", "description":"Internal error, 503" } }

{ "error":{ "type":901, "address":"/lights/1/state", "description":"Internal error, 503" } }

Parallel Activity

The described latency and throughput behavior assumes that a single application is controlling the system. In case of multiple applications sending hue API commands, the available resources in the system have to be shared, resulting in that these applications will experience a reduced throughput and increased latency.

Interruptions in IP Connection

The latency and throughput figures reported in the preceding sections are relevant for a wired Ethernet connection from the device sending the hue API commands to the bridge. If this wired connection is replaced with a wireless connection, it results in additional latencies, e.g. 4 ms in a particular test setup, which is small compared to the total latency described in the above Translation of hue API commands section.

However, in specific situations where a packet gets lost on the wireless connection between the device supplying the hue API commands and the access point, it can result in latencies of several seconds. Different access points can give quite different results and drop rates of this phenomenon. Suggested workaround to such wireless issues: Use a wired connection in case optimum performance is required.

ZigBee Multi-Hop Network

As all wireless communication, ZigBee transmissions signals are dependent on the environment, and can get weaker due to increased distance, reflections or obstructions. When two devices within a ZigBee network are not within reach of each other, intermediate nodes could relay the signal. This is called hopping and is arranged automatically. When hopping is applicable for the connection between the bridge and a light, the latency will increase and the throughput will decrease. To get optimal performance we suggest placing the bridge nearby or at least in the same room as the lights that need to be controlled.

Group Commands

The system also supports group commands via the hue API. This group command will be translated in a broadcast message on the ZigBee network. The ZigBee standard puts a limitation of the number of broadcast messages of around 1 per second to prevent possible overloading on the ZigBee network. Care should be taken to limit the number of group commands, as they will also limit the unicast commands. From an application one should balance the group and single light commands.

Entertainment API

The previous explanations were related to the REST API. Sometimes there are use cases such as syncing lights with entertainment content where you need to send fast updates to multiple lights for an extended period of time. In that case, the REST API should not be used, and instead the dedicated Hue Entertainment Streaming API should be used which is specifically designed for that purpose.

Conclusion

As a general guideline we always recommend to our developers to stay at roughly 10 commands per second to the /lights resource with a 100ms gap between each API call. For /groups commands you should keep to a maximum of 1 per second. It is however always recommended to take into consideration the above information and to of course stress test your app/system to find the optimal values for your application. For updating multiple lights at a high update rate for more than just a few seconds, the dedicated Entertainment Streaming API must be used instead of the REST API.

Watch that Transition Time.md

We attend hackathons with our developer kits and have a chance to work with developers directly trying out hue for the first time. What we have found pretty consistent is that people find the hue API easy to use.

But that doesn’t mean it’s easy for them to complete their application. Once developers start using hue they start find out a bit more about non-functional characteristics, like performance. There is a very simple component to this which people quite often fall over: transition time. Transition time is an attribute on light state. So when you set the light state there will be a transition time. However it is an optional attribute. If you don’t set it specifically, it will use the default. Transition time is set in hundred milliseconds increments. The default is 4, meaning 400 ms. So if you are changing the light state from red to blue it will do that over 400 milliseconds – by default. This is a pleasing transition for day to day use. However it is not what you need for a rapidly responsive app.

In order to make the light change its state quickly, set the transition time to zero. Also note that the transition time attribute is not persistent, it will reset to 400 ms (4) unless you set it specifically each time you set the light state!

api-reference.md

# Hue CLIP API documentation version v2

https://{bridge}/clip/v2

*   **bridge**: _required(string)_
    
    The ip address or hostname of the bridge
    

### /resource/light

API to manage light services. These are offered by devices with lighting capabilities.

#### [/resource/light](#panel_resource_light) [get](#resource_light_get)

get

×

#### get /resource/light

*   [Response](#resource_light_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of LightGet)_
    
    **Items**: LightGet
    
    *   **type**: _(light)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Deprecated: use metadata on device level
            
        *   **fixed\_mired**: _(integer – minimum: 153 – maximum: 500)_
            
            A fixed mired value of the white lamp
            
        *   **function**: _required(one of functional, decorative, mixed, unknown)_
            
            Function of the lightservice
            
    *   **product\_data**: _(object)_
        
        Factory defaults of the product data
        
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Name of the lightservice, only available for devices with multiple lightservices
            
        *   **archetype**: _(one of unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Archetype of the lightservice, only available for devices with multiple lightservices
            
        *   **function**: _required(one of functional, decorative, mixed, unknown)_
            
            Function of the lightservice
            
    *   **service\_id**: _required(integer – minimum: 0)_
        
        Service identification number. 0 indicates service of a single instance
        
    *   **on**: _required(object)_
        *   **on**: _required(boolean)_
            
            On/Off state of the light on=true, off=false
            
    *   **dimming**: _(object)_
        *   **brightness**: _required(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
        *   **min\_dim\_level**: _(number – minimum: 0 – maximum: 100)_
            
            Percentage of the maximum lumen the device outputs on minimum brightness
            
    *   **color\_temperature**: _(object)_
        *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
            
            color temperature in mirek or null when the light color is not in the ct spectrum
            
        *   **mirek\_valid**: _required(boolean)_
            
            Indication whether the value presented in mirek is valid
            
        *   **mirek\_schema**: _required(object)_
            *   **mirek\_minimum**: _required(integer – minimum: 153 – maximum: 500)_
                
                minimum color temperature this light supports
                
            *   **mirek\_maximum**: _required(integer – minimum: 153 – maximum: 500)_
                
                maximum color temperature this light supports
                
    *   **color**: _(object)_
        *   **xy**: _required(object)_
            
            CIE XY gamut position
            
            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                
                X position in color gamut
                
            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                
                Y position in color gamut
                
        *   **gamut**: _(object)_
            
            Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.
            
            *   **red**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
            *   **green**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
            *   **blue**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **gamut\_type**: _required(one of A, B, C, other)_
            
            The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut
            
    *   **dynamics**: _(object)_
        *   **status**: _required(one of dynamic\_palette, none)_
            
            Current status of the lamp with dynamics.
            
        *   **status\_values**: _required(array of SupportedDynamicStatus)_
            
            Statuses in which a lamp could be when playing dynamics.
            
        *   **speed**: _required(number – minimum: 0 – maximum: 1)_
            
            speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic\_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid
            
        *   **speed\_valid**: _required(boolean)_
            
            Indicates whether the value presented in speed is valid
            
    *   **alert**: _(object)_
        *   **action\_values**: _required(array of AlertEffectType)_
            
            Alert effects that the light supports.
            
    *   **signaling**: _(object)_
        
        Feature containing signaling properties.
        
        *   **signal\_values**: _required(array of SupportedSignals)_
            
            Signals that the light supports.
            
        *   **status**: _(object)_
            
            Indicates status of active signal. Not available when inactive.
            
            *   **signal**: _required(one of no\_signal, on\_off, on\_off\_color, alternating)_
                
                Indicates which signal is currently active.
                
            *   **estimated\_end**: _required(datetime)_
                
                Timestamp indicating when the active signal is expected to end. Value is not set if there is no\_signal
                
            *   **colors**: _required(array of ColorFeatureBasicGet)_
                
                Colors that were provided for the active effect.
                
                **Items**: ColorFeatureBasicGet
                
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
                
    *   **mode**: _required(one of normal, streaming)_
    *   **gradient**: _(object)_
        
        Basic feature containing gradient properties.
        
        *   **points**: _required(array of GradientPointGet – maxItems: 5)_
            
            Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
            
            **Items**: GradientPointGet
            
            *   **color**: _required(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            
        *   **mode**: _required(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
            
            Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
            
        *   **points\_capable**: _required(integer)_
            
            Number of color points that gradient lamp is capable of showing with gradience.
            
        *   **mode\_values**: _required(array of SupportedGradientModes)_
            
            Modes a gradient device can deploy the gradient palette of colors
            
        *   **pixel\_count**: _(integer)_
            
            Number of pixels in the device
            
    *   **effects**: _(object)_
        *   **status\_values**: _required(array of SupportedEffects)_
            
            Possible status values in which a light could be when playing an effect.
            
        *   **status**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            
            Current status values the light is in regarding effects
            
        *   **effect\_values**: _required(array of SupportedEffects)_
            
            Possible effect values you can set in a light.
            
    *   **timed\_effects**: _(object)_
        *   **status\_values**: _required(array of SupportedTimedEffects)_
            
            Possible status values in which a light could be when playing a timed effect.
            
        *   **status**: _required(one of sunrise, sunset, no\_effect)_
            
            Current status values the light is in regarding timed effects
            
        *   **effect\_values**: _required(array of SupportedTimedEffects)_
            
            Possible timed effect values you can set in a light.
            
    *   **powerup**: _(object)_
        
        Feature containing properties to configure powerup behaviour of a lightsource.
        
        *   **preset**: _required(one of safety, powerfail, last\_on\_state, custom)_
            
            When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.
            
        *   **configured**: _required(boolean)_
            
            Indicates if the shown values have been configured in the lightsource.
            
        *   **on**: _required(object)_
            *   **mode**: _required(one of on, toggle, previous)_
                
                State to activate after powerup. On will use the value specified in the “on” property. When setting mode “on”, the on property must be included. Toggle will alternate between on and off on each subsequent power toggle. Previous will return to the state it was in before powering off.
                
            *   **on**: _(object)_
                *   **on**: _required(boolean)_
                    
                    On/Off state of the light on=true, off=false
                    
        *   **dimming**: _(object)_
            *   **mode**: _required(one of dimming, previous)_
                
                Dimming will set the brightness to the specified value after power up. When setting mode “dimming”, the dimming property must be included. Previous will set brightness to the state it was in before powering off.
                
            *   **dimming**: _(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
        *   **color**: _(object)_
            *   **mode**: _required(one of color\_temperature, color, previous)_
                
                State to activate after powerup. Availability of “color\_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color\_temperature, the color\_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off.
                
            *   **color\_temperature**: _(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **color**: _(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/light/{id}](#panel_resource_light__id_) [put](#resource_light__id__put) [get](#resource_light__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/light/{id}

*   [Request](#resource_light__id__put_request)
*   [Response](#resource_light__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(light)_
    
    Type of the supported resources
    
*   **metadata**: _(object)_
    
    additional metadata including a user given name
    
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _(one of unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
        
        Deprecated: use metadata on device level
        
    *   **function**: _(one of functional, decorative, mixed, unknown)_
        
        Function of the lightservice
        
*   **identify**: _(object)_
    *   **action**: _required(identify)_
        *   identify: Triggers a visual identification sequence, current implemented as (which can change in the future): Bridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors perform LED identification cycles for 15 seconds
*   **on**: _(object)_
    *   **on**: _(boolean)_
        
        On/Off state of the light on=true, off=false
        
*   **dimming**: _(object)_
    *   **brightness**: _(number – maximum: 100)_
        
        Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
        
*   **dimming\_delta**: _(object)_
    *   **action**: _required(one of up, down, stop)_
    *   **brightness\_delta**: _(number – maximum: 100)_
        
        Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.
        
*   **color\_temperature**: _(object)_
    *   **mirek**: _(integer – minimum: 153 – maximum: 500)_
        
        color temperature in mirek or null when the light color is not in the ct spectrum
        
*   **color\_temperature\_delta**: _(object)_
    *   **action**: _required(one of up, down, stop)_
    *   **mirek\_delta**: _(integer – maximum: 347)_
        
        Mirek delta to current mirek. Clip at mirek\_minimum and mirek\_maximum of mirek\_schema.
        
*   **color**: _(object)_
    *   **xy**: _(object)_
        
        CIE XY gamut position
        
        *   **x**: _required(number – minimum: 0 – maximum: 1)_
            
            X position in color gamut
            
        *   **y**: _required(number – minimum: 0 – maximum: 1)_
            
            Y position in color gamut
            
*   **dynamics**: _(object)_
    *   **duration**: _(integer)_
        
        Duration of a light transition or timed effects in ms.
        
    *   **speed**: _(number – minimum: 0 – maximum: 1)_
        
        speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic\_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid
        
*   **alert**: _(object)_
    *   **action**: _required(breathe)_
*   **signaling**: _(object)_
    
    Feature containing signaling properties.
    
    *   **signal**: _required(one of no\_signal, on\_off, on\_off\_color, alternating)_
        
        “no\_signal”: No signal is active. Write “no\_signal” to stop active signal. “on\_off”: Toggles between max brightness and Off in fixed color. “on\_off\_color”: Toggles between off and max brightness with color provided. “alternating”: Alternates between 2 provided colors.
        
    *   **duration**: _required(integer)_
        
        Duration has a max of 65534000 ms and a stepsize of 1 second. Values inbetween steps will be rounded. Duration is ignored for no\_signal.
        
    *   **colors**: _(array of ColorFeatureBasicPut – minItems: 1 – maxItems: 2)_
        
        List of colors to apply to the signal (not supported by all signals)
        
        **Items**: ColorFeatureBasicPut
        
        *   **xy**: _(object)_
            
            CIE XY gamut position
            
            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                
                X position in color gamut
                
            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                
                Y position in color gamut
                
        
*   **gradient**: _(object)_
    
    Basic feature containing gradient properties.
    
    *   **points**: _required(array of GradientPointPut – maxItems: 5)_
        
        Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
        
        **Items**: GradientPointPut
        
        *   **color**: _required(object)_
            *   **xy**: _(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        
    *   **mode**: _(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
        
        Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
        
*   **effects**: _(object)_
    *   **effect**: _(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
*   **timed\_effects**: _(object)_
    *   **effect**: _(one of sunrise, sunset, no\_effect)_
    *   **duration**: _(integer)_
        
        Duration is mandatory when timed effect is set except for no\_effect. Resolution decreases for a larger duration. e.g Effects with duration smaller than a minute will be rounded to a resolution of 1s, while effects with duration larger than an hour will be arounded up to a resolution of 300s. Duration has a max of 21600000 ms.
        
*   **powerup**: _(object)_
    
    Feature containing properties to configure powerup behaviour of a lightsource.
    
    *   **preset**: _required(one of safety, powerfail, last\_on\_state, custom)_
        
        When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.
        
    *   **on**: _(object)_
        *   **mode**: _required(one of on, toggle, previous)_
            
            State to activate after powerup. On will use the value specified in the “on” property. When setting mode “on”, the on property must be included. Toggle will alternate between on and off on each subsequent power toggle. Previous will return to the state it was in before powering off.
            
        *   **on**: _(object)_
            *   **on**: _(boolean)_
                
                On/Off state of the light on=true, off=false
                
    *   **dimming**: _(object)_
        *   **mode**: _required(one of dimming, previous)_
            
            Dimming will set the brightness to the specified value after power up. When setting mode “dimming”, the dimming property must be included. Previous will set brightness to the state it was in before powering off.
            
        *   **dimming**: _(object)_
            *   **brightness**: _(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
    *   **color**: _(object)_
        *   **mode**: _required(one of color\_temperature, color, previous)_
            
            State to activate after powerup. Availability of “color\_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color\_temperature, the color\_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off.
            
        *   **color\_temperature**: _(object)_
            *   **mirek**: _(integer – minimum: 153 – maximum: 500)_
                
                color temperature in mirek or null when the light color is not in the ct spectrum
                
        *   **color**: _(object)_
            *   **xy**: _(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/light/{id}

*   [Request](#resource_light__id__get_request)
*   [Response](#resource_light__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of LightGet)_
    
    **Items**: LightGet
    
    *   **type**: _(light)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Deprecated: use metadata on device level
            
        *   **fixed\_mired**: _(integer – minimum: 153 – maximum: 500)_
            
            A fixed mired value of the white lamp
            
        *   **function**: _required(one of functional, decorative, mixed, unknown)_
            
            Function of the lightservice
            
    *   **product\_data**: _(object)_
        
        Factory defaults of the product data
        
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Name of the lightservice, only available for devices with multiple lightservices
            
        *   **archetype**: _(one of unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Archetype of the lightservice, only available for devices with multiple lightservices
            
        *   **function**: _required(one of functional, decorative, mixed, unknown)_
            
            Function of the lightservice
            
    *   **service\_id**: _required(integer – minimum: 0)_
        
        Service identification number. 0 indicates service of a single instance
        
    *   **on**: _required(object)_
        *   **on**: _required(boolean)_
            
            On/Off state of the light on=true, off=false
            
    *   **dimming**: _(object)_
        *   **brightness**: _required(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
        *   **min\_dim\_level**: _(number – minimum: 0 – maximum: 100)_
            
            Percentage of the maximum lumen the device outputs on minimum brightness
            
    *   **color\_temperature**: _(object)_
        *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
            
            color temperature in mirek or null when the light color is not in the ct spectrum
            
        *   **mirek\_valid**: _required(boolean)_
            
            Indication whether the value presented in mirek is valid
            
        *   **mirek\_schema**: _required(object)_
            *   **mirek\_minimum**: _required(integer – minimum: 153 – maximum: 500)_
                
                minimum color temperature this light supports
                
            *   **mirek\_maximum**: _required(integer – minimum: 153 – maximum: 500)_
                
                maximum color temperature this light supports
                
    *   **color**: _(object)_
        *   **xy**: _required(object)_
            
            CIE XY gamut position
            
            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                
                X position in color gamut
                
            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                
                Y position in color gamut
                
        *   **gamut**: _(object)_
            
            Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present.
            
            *   **red**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
            *   **green**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
            *   **blue**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **gamut\_type**: _required(one of A, B, C, other)_
            
            The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut
            
    *   **dynamics**: _(object)_
        *   **status**: _required(one of dynamic\_palette, none)_
            
            Current status of the lamp with dynamics.
            
        *   **status\_values**: _required(array of SupportedDynamicStatus)_
            
            Statuses in which a lamp could be when playing dynamics.
            
        *   **speed**: _required(number – minimum: 0 – maximum: 1)_
            
            speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic\_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid
            
        *   **speed\_valid**: _required(boolean)_
            
            Indicates whether the value presented in speed is valid
            
    *   **alert**: _(object)_
        *   **action\_values**: _required(array of AlertEffectType)_
            
            Alert effects that the light supports.
            
    *   **signaling**: _(object)_
        
        Feature containing signaling properties.
        
        *   **signal\_values**: _required(array of SupportedSignals)_
            
            Signals that the light supports.
            
        *   **status**: _(object)_
            
            Indicates status of active signal. Not available when inactive.
            
            *   **signal**: _required(one of no\_signal, on\_off, on\_off\_color, alternating)_
                
                Indicates which signal is currently active.
                
            *   **estimated\_end**: _required(datetime)_
                
                Timestamp indicating when the active signal is expected to end. Value is not set if there is no\_signal
                
            *   **colors**: _required(array of ColorFeatureBasicGet)_
                
                Colors that were provided for the active effect.
                
                **Items**: ColorFeatureBasicGet
                
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
                
    *   **mode**: _required(one of normal, streaming)_
    *   **gradient**: _(object)_
        
        Basic feature containing gradient properties.
        
        *   **points**: _required(array of GradientPointGet – maxItems: 5)_
            
            Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
            
            **Items**: GradientPointGet
            
            *   **color**: _required(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            
        *   **mode**: _required(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
            
            Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
            
        *   **points\_capable**: _required(integer)_
            
            Number of color points that gradient lamp is capable of showing with gradience.
            
        *   **mode\_values**: _required(array of SupportedGradientModes)_
            
            Modes a gradient device can deploy the gradient palette of colors
            
        *   **pixel\_count**: _(integer)_
            
            Number of pixels in the device
            
    *   **effects**: _(object)_
        *   **status\_values**: _required(array of SupportedEffects)_
            
            Possible status values in which a light could be when playing an effect.
            
        *   **status**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            
            Current status values the light is in regarding effects
            
        *   **effect\_values**: _required(array of SupportedEffects)_
            
            Possible effect values you can set in a light.
            
    *   **timed\_effects**: _(object)_
        *   **status\_values**: _required(array of SupportedTimedEffects)_
            
            Possible status values in which a light could be when playing a timed effect.
            
        *   **status**: _required(one of sunrise, sunset, no\_effect)_
            
            Current status values the light is in regarding timed effects
            
        *   **effect\_values**: _required(array of SupportedTimedEffects)_
            
            Possible timed effect values you can set in a light.
            
    *   **powerup**: _(object)_
        
        Feature containing properties to configure powerup behaviour of a lightsource.
        
        *   **preset**: _required(one of safety, powerfail, last\_on\_state, custom)_
            
            When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.
            
        *   **configured**: _required(boolean)_
            
            Indicates if the shown values have been configured in the lightsource.
            
        *   **on**: _required(object)_
            *   **mode**: _required(one of on, toggle, previous)_
                
                State to activate after powerup. On will use the value specified in the “on” property. When setting mode “on”, the on property must be included. Toggle will alternate between on and off on each subsequent power toggle. Previous will return to the state it was in before powering off.
                
            *   **on**: _(object)_
                *   **on**: _required(boolean)_
                    
                    On/Off state of the light on=true, off=false
                    
        *   **dimming**: _(object)_
            *   **mode**: _required(one of dimming, previous)_
                
                Dimming will set the brightness to the specified value after power up. When setting mode “dimming”, the dimming property must be included. Previous will set brightness to the state it was in before powering off.
                
            *   **dimming**: _(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
        *   **color**: _(object)_
            *   **mode**: _required(one of color\_temperature, color, previous)_
                
                State to activate after powerup. Availability of “color\_temperature” and “color” modes depend on the capabilities of the lamp. Colortemperature will set the colortemperature to the specified value after power up. When setting color\_temperature, the color\_temperature property must be included Color will set the color tot he specified value after power up. When setting color mode, the color property must be included Previous will set color to the state it was in before powering off.
                
            *   **color\_temperature**: _(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **color**: _(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/scene

API to manage scenes. Scenes are used to store and recall settings for a group of lights.

#### [/resource/scene](#panel_resource_scene) [post](#resource_scene_post) [get](#resource_scene_get)

post

get

×

#### post /resource/scene

*   [Request](#resource_scene_post_request)
*   [Response](#resource_scene_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(scene)_
    
    Type of the supported resources
    
*   **actions**: _required(array of ActionPost)_
    
    List of actions to be executed synchronously on recall
    
    **Items**: ActionPost
    
    *   **target**: _required(object)_
        
        The identifier of the light to execute the action on
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **action**: _required(object)_
        
        the action to be executed on recall
        
        *   **on**: _(object)_
            *   **on**: _required(boolean)_
                
                On/Off state of the light on=true, off=false
                
        *   **dimming**: _(object)_
            *   **brightness**: _required(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        *   **color**: _(object)_
            *   **xy**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **color\_temperature**: _(object)_
            *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                
                color temperature in mirek or null when the light color is not in the ct spectrum
                
        *   **gradient**: _(object)_
            
            Basic feature containing gradient properties.
            
            *   **points**: _required(array of GradientPointPost – maxItems: 5)_
                
                Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
                
                **Items**: GradientPointPost
                
                *   **color**: _required(object)_
                    *   **xy**: _required(object)_
                        
                        CIE XY gamut position
                        
                        *   **x**: _required(number – minimum: 0 – maximum: 1)_
                            
                            X position in color gamut
                            
                        *   **y**: _required(number – minimum: 0 – maximum: 1)_
                            
                            Y position in color gamut
                            
                
            *   **mode**: _(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
                
                Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
                
        *   **effects**: _(object)_
            
            Basic feature containing effect properties.
            
            *   **effect**: _(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
        *   **dynamics**: _(object)_
            *   **duration**: _(integer)_
                
                Duration of a light transition or timed effects in ms.
                
    
*   **palette**: _(object)_
    
    Group of colors that describe the palette of colors to be used when playing dynamics
    
    *   **color**: _required(array of ColorPalettePost – minItems: 0 – maxItems: 9)_
        
        **Items**: ColorPalettePost
        
        *   **color**: _required(object)_
            *   **xy**: _required(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **dimming**: _required(object)_
            *   **brightness**: _required(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        
    *   **dimming**: _required(array of DimmingFeatureBasicPost – minItems: 0 – maxItems: 1)_
        
        **Items**: DimmingFeatureBasicPost
        
        *   **brightness**: _required(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
        
    *   **color\_temperature**: _required(array of ColorTemperaturePalettePost – minItems: 0 – maxItems: 1)_
        
        **Items**: ColorTemperaturePalettePost
        
        *   **color\_temperature**: _required(object)_
            *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                
                color temperature in mirek or null when the light color is not in the ct spectrum
                
        *   **dimming**: _required(object)_
            *   **brightness**: _required(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        
    *   **effects**: _(array of EffectFeatureBasicPost – minItems: 0 – maxItems: 3)_
        
        **Items**: EffectFeatureBasicPost
        
        *   **effect**: _(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
        
*   **metadata**: _required(object)_
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **image**: _(object)_
        
        Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
        
        Application specific data. Free format string.
        
*   **group**: _required(object)_
    
    Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
*   **speed**: _(number – minimum: 0 – maximum: 1)_
    
    Speed of dynamic palette for this scene
    
*   **auto\_dynamic**: _(boolean)_
    
    Indicates whether to automatically start the scene dynamically on active recall
    

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/scene

*   [Response](#resource_scene_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of SceneGet)_
    
    **Items**: SceneGet
    
    *   **type**: _(scene)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **actions**: _required(array of ActionGet)_
        
        List of actions to be executed synchronously on recall
        
        **Items**: ActionGet
        
        *   **target**: _required(object)_
            
            The identifier of the light to execute the action on
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **action**: _required(object)_
            
            the action to be executed on recall
            
            *   **on**: _(object)_
                *   **on**: _required(boolean)_
                    
                    On/Off state of the light on=true, off=false
                    
            *   **dimming**: _(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            *   **color**: _(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            *   **color\_temperature**: _(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **gradient**: _(object)_
                
                Basic feature containing gradient properties.
                
                *   **points**: _required(array of GradientPointGet – maxItems: 5)_
                    
                    Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
                    
                    **Items**: GradientPointGet
                    
                    *   **color**: _required(object)_
                        *   **xy**: _required(object)_
                            
                            CIE XY gamut position
                            
                            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                                
                                X position in color gamut
                                
                            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                                
                                Y position in color gamut
                                
                    
                *   **mode**: _required(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
                    
                    Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
                    
            *   **effects**: _(object)_
                
                Basic feature containing effect properties.
                
                *   **effect**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            *   **dynamics**: _(object)_
                *   **duration**: _(integer)_
                    
                    Duration of a light transition or timed effects in ms.
                    
        
    *   **palette**: _(object)_
        
        Group of colors that describe the palette of colors to be used when playing dynamics
        
        *   **color**: _required(array of ColorPaletteGet – minItems: 0 – maxItems: 9)_
            
            **Items**: ColorPaletteGet
            
            *   **color**: _required(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            *   **dimming**: _required(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            
        *   **dimming**: _required(array of DimmingFeatureBasicGet – minItems: 0 – maxItems: 1)_
            
            **Items**: DimmingFeatureBasicGet
            
            *   **brightness**: _required(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
            
        *   **color\_temperature**: _required(array of ColorTemperaturePaletteGet – minItems: 0 – maxItems: 1)_
            
            **Items**: ColorTemperaturePaletteGet
            
            *   **color\_temperature**: _required(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **dimming**: _required(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            
        *   **effects**: _required(array of EffectFeatureBasicGet – minItems: 0 – maxItems: 3)_
            
            **Items**: EffectFeatureBasicGet
            
            *   **effect**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **image**: _(object)_
            
            Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
            
            Application specific data. Free format string.
            
    *   **group**: _required(object)_
        
        Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **speed**: _required(number – minimum: 0 – maximum: 1)_
        
        Speed of dynamic palette for this scene
        
    *   **auto\_dynamic**: _required(boolean)_
        
        Indicates whether to automatically start the scene dynamically on active recall
        
    *   **status**: _required(object)_
        *   **active**: _(one of inactive, static, dynamic\_palette)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/scene/{id}](#panel_resource_scene__id_) [delete](#resource_scene__id__delete) [put](#resource_scene__id__put) [get](#resource_scene__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/scene/{id}

*   [Request](#resource_scene__id__delete_request)
*   [Response](#resource_scene__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/scene/{id}

*   [Request](#resource_scene__id__put_request)
*   [Response](#resource_scene__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(scene)_
    
    Type of the supported resources
    
*   **actions**: _(array of ActionPut)_
    
    List of actions to be executed synchronously on recall
    
    **Items**: ActionPut
    
    *   **target**: _required(object)_
        
        The identifier of the light to execute the action on
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **action**: _required(object)_
        
        the action to be executed on recall
        
        *   **on**: _(object)_
            *   **on**: _(boolean)_
                
                On/Off state of the light on=true, off=false
                
        *   **dimming**: _(object)_
            *   **brightness**: _(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        *   **color**: _(object)_
            *   **xy**: _(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **color\_temperature**: _(object)_
            *   **mirek**: _(integer – minimum: 153 – maximum: 500)_
                
                color temperature in mirek or null when the light color is not in the ct spectrum
                
        *   **gradient**: _(object)_
            
            Basic feature containing gradient properties.
            
            *   **points**: _required(array of GradientPointPut – maxItems: 5)_
                
                Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
                
                **Items**: GradientPointPut
                
                *   **color**: _required(object)_
                    *   **xy**: _(object)_
                        
                        CIE XY gamut position
                        
                        *   **x**: _required(number – minimum: 0 – maximum: 1)_
                            
                            X position in color gamut
                            
                        *   **y**: _required(number – minimum: 0 – maximum: 1)_
                            
                            Y position in color gamut
                            
                
            *   **mode**: _(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
                
                Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
                
        *   **effects**: _(object)_
            
            Basic feature containing effect properties.
            
            *   **effect**: _(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
        *   **dynamics**: _(object)_
            *   **duration**: _(integer)_
                
                Duration of a light transition or timed effects in ms.
                
    
*   **palette**: _(object)_
    
    Group of colors that describe the palette of colors to be used when playing dynamics
    
    *   **color**: _required(array of ColorPalettePut – minItems: 0 – maxItems: 9)_
        
        **Items**: ColorPalettePut
        
        *   **color**: _required(object)_
            *   **xy**: _(object)_
                
                CIE XY gamut position
                
                *   **x**: _required(number – minimum: 0 – maximum: 1)_
                    
                    X position in color gamut
                    
                *   **y**: _required(number – minimum: 0 – maximum: 1)_
                    
                    Y position in color gamut
                    
        *   **dimming**: _required(object)_
            *   **brightness**: _(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        
    *   **dimming**: _required(array of DimmingFeatureBasicPut – minItems: 0 – maxItems: 1)_
        
        **Items**: DimmingFeatureBasicPut
        
        *   **brightness**: _(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
        
    *   **color\_temperature**: _required(array of ColorTemperaturePalettePut – minItems: 0 – maxItems: 1)_
        
        **Items**: ColorTemperaturePalettePut
        
        *   **color\_temperature**: _required(object)_
            *   **mirek**: _(integer – minimum: 153 – maximum: 500)_
                
                color temperature in mirek or null when the light color is not in the ct spectrum
                
        *   **dimming**: _required(object)_
            *   **brightness**: _(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
        
    *   **effects**: _(array of EffectFeatureBasicPut – minItems: 0 – maxItems: 3)_
        
        **Items**: EffectFeatureBasicPut
        
        *   **effect**: _(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
        
*   **recall**: _(object)_
    *   **action**: _(one of active, dynamic\_palette, static)_
        
        When writing active, the actions in the scene are executed on the target. dynamic\_palette starts dynamic scene with colors in the Palette object.
        
    *   **duration**: _(integer)_
        
        transition to the scene within the timeframe given by duration
        
    *   **dimming**: _(object)_
        
        override the scene dimming/brightness
        
        *   **brightness**: _(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
*   **metadata**: _(object)_
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
        
        Application specific data. Free format string.
        
*   **speed**: _(number – minimum: 0 – maximum: 1)_
    
    Speed of dynamic palette for this scene
    
*   **auto\_dynamic**: _(boolean)_
    
    Indicates whether to automatically start the scene dynamically on active recall
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/scene/{id}

*   [Request](#resource_scene__id__get_request)
*   [Response](#resource_scene__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of SceneGet)_
    
    **Items**: SceneGet
    
    *   **type**: _(scene)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **actions**: _required(array of ActionGet)_
        
        List of actions to be executed synchronously on recall
        
        **Items**: ActionGet
        
        *   **target**: _required(object)_
            
            The identifier of the light to execute the action on
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **action**: _required(object)_
            
            the action to be executed on recall
            
            *   **on**: _(object)_
                *   **on**: _required(boolean)_
                    
                    On/Off state of the light on=true, off=false
                    
            *   **dimming**: _(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            *   **color**: _(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            *   **color\_temperature**: _(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **gradient**: _(object)_
                
                Basic feature containing gradient properties.
                
                *   **points**: _required(array of GradientPointGet – maxItems: 5)_
                    
                    Collection of gradients points. For control of the gradient points through a PUT a minimum of 2 points need to be provided.
                    
                    **Items**: GradientPointGet
                    
                    *   **color**: _required(object)_
                        *   **xy**: _required(object)_
                            
                            CIE XY gamut position
                            
                            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                                
                                X position in color gamut
                                
                            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                                
                                Y position in color gamut
                                
                    
                *   **mode**: _required(one of interpolated\_palette, interpolated\_palette\_mirrored, random\_pixelated)_
                    
                    Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated\_palette
                    
            *   **effects**: _(object)_
                
                Basic feature containing effect properties.
                
                *   **effect**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            *   **dynamics**: _(object)_
                *   **duration**: _(integer)_
                    
                    Duration of a light transition or timed effects in ms.
                    
        
    *   **palette**: _(object)_
        
        Group of colors that describe the palette of colors to be used when playing dynamics
        
        *   **color**: _required(array of ColorPaletteGet – minItems: 0 – maxItems: 9)_
            
            **Items**: ColorPaletteGet
            
            *   **color**: _required(object)_
                *   **xy**: _required(object)_
                    
                    CIE XY gamut position
                    
                    *   **x**: _required(number – minimum: 0 – maximum: 1)_
                        
                        X position in color gamut
                        
                    *   **y**: _required(number – minimum: 0 – maximum: 1)_
                        
                        Y position in color gamut
                        
            *   **dimming**: _required(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            
        *   **dimming**: _required(array of DimmingFeatureBasicGet – minItems: 0 – maxItems: 1)_
            
            **Items**: DimmingFeatureBasicGet
            
            *   **brightness**: _required(number – maximum: 100)_
                
                Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                
            
        *   **color\_temperature**: _required(array of ColorTemperaturePaletteGet – minItems: 0 – maxItems: 1)_
            
            **Items**: ColorTemperaturePaletteGet
            
            *   **color\_temperature**: _required(object)_
                *   **mirek**: _required(integer – minimum: 153 – maximum: 500)_
                    
                    color temperature in mirek or null when the light color is not in the ct spectrum
                    
            *   **dimming**: _required(object)_
                *   **brightness**: _required(number – maximum: 100)_
                    
                    Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
                    
            
        *   **effects**: _required(array of EffectFeatureBasicGet – minItems: 0 – maxItems: 3)_
            
            **Items**: EffectFeatureBasicGet
            
            *   **effect**: _required(one of prism, opal, glisten, sparkle, fire, candle, no\_effect)_
            
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **image**: _(object)_
            
            Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
            
            Application specific data. Free format string.
            
    *   **group**: _required(object)_
        
        Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **speed**: _required(number – minimum: 0 – maximum: 1)_
        
        Speed of dynamic palette for this scene
        
    *   **auto\_dynamic**: _required(boolean)_
        
        Indicates whether to automatically start the scene dynamically on active recall
        
    *   **status**: _required(object)_
        *   **active**: _(one of inactive, static, dynamic\_palette)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/room

API to manage rooms. Rooms group devices and each device can only be part of one room.

#### [/resource/room](#panel_resource_room) [post](#resource_room_post) [get](#resource_room_get)

post

get

×

#### post /resource/room

*   [Request](#resource_room_post_request)
*   [Response](#resource_room_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(room)_
    
    Type of the supported resources
    
*   **children**: _required(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _required(object)_
    
    configuration object for a room
    
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
        
        possible archetypes of a room
        

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/room

*   [Response](#resource_room_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of RoomGet)_
    
    **Items**: RoomGet
    
    *   **type**: _(room)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        configuration object for a room
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
            
            possible archetypes of a room
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/room/{id}](#panel_resource_room__id_) [delete](#resource_room__id__delete) [put](#resource_room__id__put) [get](#resource_room__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/room/{id}

*   [Request](#resource_room__id__delete_request)
*   [Response](#resource_room__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/room/{id}

*   [Request](#resource_room__id__put_request)
*   [Response](#resource_room__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(room)_
    
    Type of the supported resources
    
*   **children**: _(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _(object)_
    
    configuration object for a room
    
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
        
        possible archetypes of a room
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/room/{id}

*   [Request](#resource_room__id__get_request)
*   [Response](#resource_room__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of RoomGet)_
    
    **Items**: RoomGet
    
    *   **type**: _(room)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        configuration object for a room
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
            
            possible archetypes of a room
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/zone

API to manage zones. Zones group services and each service can be part of multiple zones.

#### [/resource/zone](#panel_resource_zone) [post](#resource_zone_post) [get](#resource_zone_get)

post

get

×

#### post /resource/zone

*   [Request](#resource_zone_post_request)
*   [Response](#resource_zone_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(zone)_
    
    Type of the supported resources
    
*   **children**: _required(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _required(object)_
    
    configuration object for a room
    
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
        
        possible archetypes of a room
        

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/zone

*   [Response](#resource_zone_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZoneGet)_
    
    **Items**: ZoneGet
    
    *   **type**: _(zone)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        configuration object for a room
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
            
            possible archetypes of a room
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/zone/{id}](#panel_resource_zone__id_) [delete](#resource_zone__id__delete) [put](#resource_zone__id__put) [get](#resource_zone__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/zone/{id}

*   [Request](#resource_zone__id__delete_request)
*   [Response](#resource_zone__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/zone/{id}

*   [Request](#resource_zone__id__put_request)
*   [Response](#resource_zone__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(zone)_
    
    Type of the supported resources
    
*   **children**: _(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _(object)_
    
    configuration object for a room
    
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
        
        possible archetypes of a room
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/zone/{id}

*   [Request](#resource_zone__id__get_request)
*   [Response](#resource_zone__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZoneGet)_
    
    **Items**: ZoneGet
    
    *   **type**: _(zone)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        configuration object for a room
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of living\_room, kitchen, dining, bedroom, kids\_bedroom, bathroom, nursery, recreation, office, gym, hallway, toilet, front\_door, garage, terrace, garden, driveway, carport, home, downstairs, upstairs, top\_floor, attic, guest\_room, staircase, lounge, man\_cave, computer, studio, music, tv, reading, closet, storage, laundry\_room, balcony, porch, barbecue, pool, other)_
            
            possible archetypes of a room
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/bridge\_home

API to manage bridge homes. Homes group rooms as well as devices not assigned to a room.

#### [/resource/bridge\_home](#panel_resource_bridge_home) [get](#resource_bridge_home_get)

get

×

#### get /resource/bridge\_home

*   [Response](#resource_bridge_home_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BridgeHomeGet)_
    
    **Items**: BridgeHomeGet
    
    *   **type**: _(bridge\_home)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/bridge\_home/{id}](#panel_resource_bridge_home__id_) [get](#resource_bridge_home__id__get)

API calls for resource which can be just retrieved (GET on resource instance)

get

×

#### get /resource/bridge\_home/{id}

*   [Request](#resource_bridge_home__id__get_request)
*   [Response](#resource_bridge_home__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BridgeHomeGet)_
    
    **Items**: BridgeHomeGet
    
    *   **type**: _(bridge\_home)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/grouped\_light

API to manage grouped light services. These are offered by rooms, zones, and homes.

#### [/resource/grouped\_light](#panel_resource_grouped_light) [get](#resource_grouped_light_get)

get

×

#### get /resource/grouped\_light

*   [Response](#resource_grouped_light_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedLightGet)_
    
    **Items**: GroupedLightGet
    
    *   **type**: _(grouped\_light)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **on**: _(object)_
        
        Joined on control & aggregated on state.| – “on” is true if any light in the group is on
        
        *   **on**: _required(boolean)_
            
            On/Off state of the light on=true, off=false
            
    *   **dimming**: _(object)_
        
        Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.
        
        *   **brightness**: _required(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
    *   **alert**: _(object)_
        
        Joined alert control
        
        *   **action\_values**: _required(array of AlertEffectType)_
            
            Alert effects that the light supports.
            
    *   **signaling**: _(object)_
        
        Feature containing basic signaling properties.
        
        *   **signal\_values**: _required(array of SupportedSignals)_
            
            Signals that the light supports.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/grouped\_light/{id}](#panel_resource_grouped_light__id_) [put](#resource_grouped_light__id__put) [get](#resource_grouped_light__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/grouped\_light/{id}

*   [Request](#resource_grouped_light__id__put_request)
*   [Response](#resource_grouped_light__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(grouped\_light)_
    
    Type of the supported resources
    
*   **on**: _(object)_
    
    Joined on control & aggregated on state.| – “on” is true if any light in the group is on
    
    *   **on**: _(boolean)_
        
        On/Off state of the light on=true, off=false
        
*   **dimming**: _(object)_
    
    Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.
    
    *   **brightness**: _(number – maximum: 100)_
        
        Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
        
*   **dimming\_delta**: _(object)_
    *   **action**: _required(one of up, down, stop)_
    *   **brightness\_delta**: _(number – maximum: 100)_
        
        Brightness percentage of full-scale increase delta to current dimlevel. Clip at Max-level or Min-level.
        
*   **color\_temperature**: _(object)_
    
    Joined color temperature control
    
    *   **mirek**: _(integer – minimum: 153 – maximum: 500)_
        
        color temperature in mirek or null when the light color is not in the ct spectrum
        
*   **color\_temperature\_delta**: _(object)_
    *   **action**: _required(one of up, down, stop)_
    *   **mirek\_delta**: _(integer – maximum: 347)_
        
        Mirek delta to current mirek. Clip at mirek\_minimum and mirek\_maximum of mirek\_schema.
        
*   **color**: _(object)_
    
    Joined color control
    
    *   **xy**: _(object)_
        
        CIE XY gamut position
        
        *   **x**: _required(number – minimum: 0 – maximum: 1)_
            
            X position in color gamut
            
        *   **y**: _required(number – minimum: 0 – maximum: 1)_
            
            Y position in color gamut
            
*   **alert**: _(object)_
    
    Joined alert control
    
    *   **action**: _required(breathe)_
*   **signaling**: _(object)_
    
    Feature containing basic signaling properties.
    
    *   **signal**: _required(one of no\_signal, on\_off, on\_off\_color, alternating)_
        
        “no\_signal”: No signal is active. Write “no\_signal” to stop active signal. “on\_off”: Toggles between max brightness and Off in fixed color. “on\_off\_color”: Toggles between off and max brightness with color provided. “alternating”: Alternates between 2 provided colors.
        
    *   **duration**: _required(integer)_
        
        Duration has a max of 65534000 ms and a stepsize of 1 second. Values inbetween steps will be rounded. Duration is ignored for no\_signal.
        
    *   **colors**: _(array of ColorFeatureBasicPut – minItems: 1 – maxItems: 2)_
        
        List of colors to apply to the signal (not supported by all signals)
        
        **Items**: ColorFeatureBasicPut
        
        *   **xy**: _(object)_
            
            CIE XY gamut position
            
            *   **x**: _required(number – minimum: 0 – maximum: 1)_
                
                X position in color gamut
                
            *   **y**: _required(number – minimum: 0 – maximum: 1)_
                
                Y position in color gamut
                
        
*   **dynamics**: _(object)_
    *   **duration**: _(integer)_
        
        Duration of a light transition or timed effects in ms.
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/grouped\_light/{id}

*   [Request](#resource_grouped_light__id__get_request)
*   [Response](#resource_grouped_light__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedLightGet)_
    
    **Items**: GroupedLightGet
    
    *   **type**: _(grouped\_light)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **on**: _(object)_
        
        Joined on control & aggregated on state.| – “on” is true if any light in the group is on
        
        *   **on**: _required(boolean)_
            
            On/Off state of the light on=true, off=false
            
    *   **dimming**: _(object)_
        
        Joined dimming control – “dimming.brightness” contains average brightness of group containing turned-on lights only.
        
        *   **brightness**: _required(number – maximum: 100)_
            
            Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness
            
    *   **alert**: _(object)_
        
        Joined alert control
        
        *   **action\_values**: _required(array of AlertEffectType)_
            
            Alert effects that the light supports.
            
    *   **signaling**: _(object)_
        
        Feature containing basic signaling properties.
        
        *   **signal\_values**: _required(array of SupportedSignals)_
            
            Signals that the light supports.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/device

API to manage devices. Devices have device level properties and offer services such as light. Bridge device cannot be deleted.

#### [/resource/device](#panel_resource_device) [get](#resource_device_get)

get

×

#### get /resource/device

*   [Response](#resource_device_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DeviceGet)_
    
    **Items**: DeviceGet
    
    *   **type**: _(device)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **product\_data**: _required(object)_
        *   **model\_id**: _required(string)_
            
            unique identification of device model
            
        *   **manufacturer\_name**: _required(string)_
            
            Name of device manufacturer
            
        *   **product\_name**: _required(string)_
            
            Name of the product.
            
        *   **product\_archetype**: _required(one of bridge\_v2, unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Archetype of the product
            
        *   **certified**: _required(boolean)_
            
            This device is Hue certified
            
        *   **software\_version**: _required(string – pattern: \\d+\\.\\d+\\.\\d+)_
            
            Software version of the product
            
        *   **hardware\_platform\_type**: _(string)_
            
            Hardware type; identified by Manufacturer code and ImageType
            
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of bridge\_v2, unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            By default archetype given by manufacturer. Can be changed by user.
            
    *   **usertest**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **usertest**: _required(boolean)_
            
            Activates or extends user usertest mode of device for 120 seconds. false deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)
            
    *   **device\_mode**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **mode**: _required(one of switch\_single\_rocker, switch\_single\_pushbutton, switch\_dual\_rocker, switch\_dual\_pushbutton)_
            
            current mode (on read) or requested mode (on write) of the device
            
        *   **mode\_values**: _required(array of DeviceModeType)_
            
            the modes that the device supports
            
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services providing control and state of the device.
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/device/{id}](#panel_resource_device__id_) [delete](#resource_device__id__delete) [put](#resource_device__id__put) [get](#resource_device__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/device/{id}

*   [Request](#resource_device__id__delete_request)
*   [Response](#resource_device__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/device/{id}

*   [Request](#resource_device__id__put_request)
*   [Response](#resource_device__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(device)_
    
    Type of the supported resources
    
*   **metadata**: _(object)_
    
    additional metadata including a user given name
    
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **archetype**: _(one of bridge\_v2, unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
        
        By default archetype given by manufacturer. Can be changed by user.
        
*   **identify**: _(object)_
    *   **action**: _required(identify)_
        *   identify: Triggers a visual identification sequence, current implemented as (which can change in the future): Bridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors perform LED identification cycles for 15 seconds
*   **usertest**: _(object)_
    *   **usertest**: _(boolean)_
        
        Activates or extends user usertest mode of device for 120 seconds. false deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)
        
*   **device\_mode**: _(object)_
    *   **mode**: _required(one of switch\_single\_rocker, switch\_single\_pushbutton, switch\_dual\_rocker, switch\_dual\_pushbutton)_
        
        current mode (on read) or requested mode (on write) of the device
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/device/{id}

*   [Request](#resource_device__id__get_request)
*   [Response](#resource_device__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DeviceGet)_
    
    **Items**: DeviceGet
    
    *   **type**: _(device)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **product\_data**: _required(object)_
        *   **model\_id**: _required(string)_
            
            unique identification of device model
            
        *   **manufacturer\_name**: _required(string)_
            
            Name of device manufacturer
            
        *   **product\_name**: _required(string)_
            
            Name of the product.
            
        *   **product\_archetype**: _required(one of bridge\_v2, unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            Archetype of the product
            
        *   **certified**: _required(boolean)_
            
            This device is Hue certified
            
        *   **software\_version**: _required(string – pattern: \\d+\\.\\d+\\.\\d+)_
            
            Software version of the product
            
        *   **hardware\_platform\_type**: _(string)_
            
            Hardware type; identified by Manufacturer code and ImageType
            
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **archetype**: _required(one of bridge\_v2, unknown\_archetype, classic\_bulb, sultan\_bulb, flood\_bulb, spot\_bulb, candle\_bulb, luster\_bulb, pendant\_round, pendant\_long, ceiling\_round, ceiling\_square, floor\_shade, floor\_lantern, table\_shade, recessed\_ceiling, recessed\_floor, single\_spot, double\_spot, table\_wash, wall\_lantern, wall\_shade, flexible\_lamp, ground\_spot, wall\_spot, plug, hue\_go, hue\_lightstrip, hue\_iris, hue\_bloom, bollard, wall\_washer, hue\_play, vintage\_bulb, vintage\_candle\_bulb, ellipse\_bulb, triangle\_bulb, small\_globe\_bulb, large\_globe\_bulb, edison\_bulb, christmas\_tree, string\_light, hue\_centris, hue\_lightstrip\_tv, hue\_lightstrip\_pc, hue\_tube, hue\_signe, pendant\_spot, ceiling\_horizontal, ceiling\_tube, up\_and\_down, up\_and\_down\_up, up\_and\_down\_down, hue\_floodlight\_camera)_
            
            By default archetype given by manufacturer. Can be changed by user.
            
    *   **usertest**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **usertest**: _required(boolean)_
            
            Activates or extends user usertest mode of device for 120 seconds. false deactivates usertest mode. In usertest mode, devices report changes in state faster and indicate state changes on device LED (if applicable)
            
    *   **device\_mode**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **mode**: _required(one of switch\_single\_rocker, switch\_single\_pushbutton, switch\_dual\_rocker, switch\_dual\_pushbutton)_
            
            current mode (on read) or requested mode (on write) of the device
            
        *   **mode\_values**: _required(array of DeviceModeType)_
            
            the modes that the device supports
            
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services providing control and state of the device.
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/bridge

API to manage the bridge

#### [/resource/bridge](#panel_resource_bridge) [get](#resource_bridge_get)

get

×

#### get /resource/bridge

*   [Response](#resource_bridge_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BridgeGet)_
    
    **Items**: BridgeGet
    
    *   **type**: _(bridge)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **bridge\_id**: _required(string)_
        
        Unique identifier of the bridge as printed on the device. Lower case (shouldn't it be upper case?)
        
    *   **time\_zone**: _required(object)_
        *   **time\_zone**: _required(string)_
            
            Time zone where the user's home is located (as Olson ID).
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/bridge/{id}](#panel_resource_bridge__id_) [put](#resource_bridge__id__put) [get](#resource_bridge__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/bridge/{id}

*   [Request](#resource_bridge__id__put_request)
*   [Response](#resource_bridge__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(bridge)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/bridge/{id}

*   [Request](#resource_bridge__id__get_request)
*   [Response](#resource_bridge__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BridgeGet)_
    
    **Items**: BridgeGet
    
    *   **type**: _(bridge)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **bridge\_id**: _required(string)_
        
        Unique identifier of the bridge as printed on the device. Lower case (shouldn't it be upper case?)
        
    *   **time\_zone**: _required(object)_
        *   **time\_zone**: _required(string)_
            
            Time zone where the user's home is located (as Olson ID).
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/device\_software\_update

API to manage device update services. These services are present for devices that support software update.”

#### [/resource/device\_software\_update](#panel_resource_device_software_update) [get](#resource_device_software_update_get)

get

×

#### get /resource/device\_software\_update

*   [Response](#resource_device_software_update_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DeviceSoftwareUpdateGet)_
    
    **Items**: DeviceSoftwareUpdateGet
    
    *   **type**: _(device\_software\_update)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **state**: _required(one of no\_update, update\_pending, ready\_to\_install, installing)_
        
        software update status of the device.
        
        *   no\_update – No software update available known for the device – update\_pending – There is an update pending but not ready to install. (means the update is known, but transfer has not started or completed) – ready\_to\_install – The update is ready to be installed. – installing – The update is being installed.
    *   **problems**: _required(array of DeviceSoftwareUpdateProblem)_
        
        Problems with software update that need user intervention
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/device\_software\_update/{id}](#panel_resource_device_software_update__id_) [put](#resource_device_software_update__id__put) [get](#resource_device_software_update__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/device\_software\_update/{id}

*   [Request](#resource_device_software_update__id__put_request)
*   [Response](#resource_device_software_update__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(device\_software\_update)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/device\_software\_update/{id}

*   [Request](#resource_device_software_update__id__get_request)
*   [Response](#resource_device_software_update__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DeviceSoftwareUpdateGet)_
    
    **Items**: DeviceSoftwareUpdateGet
    
    *   **type**: _(device\_software\_update)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **state**: _required(one of no\_update, update\_pending, ready\_to\_install, installing)_
        
        software update status of the device.
        
        *   no\_update – No software update available known for the device – update\_pending – There is an update pending but not ready to install. (means the update is known, but transfer has not started or completed) – ready\_to\_install – The update is ready to be installed. – installing – The update is being installed.
    *   **problems**: _required(array of DeviceSoftwareUpdateProblem)_
        
        Problems with software update that need user intervention
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/device\_power

API to manage device power services. These are offered by battery powered devices.

#### [/resource/device\_power](#panel_resource_device_power) [get](#resource_device_power_get)

get

×

#### get /resource/device\_power

*   [Response](#resource_device_power_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DevicePowerGet)_
    
    **Items**: DevicePowerGet
    
    *   **type**: _(device\_power)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **power\_state**: _required(object)_
        *   **battery\_state**: _(one of normal, low, critical)_
            
            status of the power source of a device, only for battery powered devices.
            
            *   normal – battery level is sufficient – low – battery level low, some features (e.g. software update) might stop working, please change battery soon – critical – battery level critical, device can fail any moment
        *   **battery\_level**: _(integer – minimum: 0 – maximum: 100)_
            
            The current battery state in percent, only for battery powered devices.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/device\_power/{id}](#panel_resource_device_power__id_) [put](#resource_device_power__id__put) [get](#resource_device_power__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/device\_power/{id}

*   [Request](#resource_device_power__id__put_request)
*   [Response](#resource_device_power__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(device\_power)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/device\_power/{id}

*   [Request](#resource_device_power__id__get_request)
*   [Response](#resource_device_power__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of DevicePowerGet)_
    
    **Items**: DevicePowerGet
    
    *   **type**: _(device\_power)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **power\_state**: _required(object)_
        *   **battery\_state**: _(one of normal, low, critical)_
            
            status of the power source of a device, only for battery powered devices.
            
            *   normal – battery level is sufficient – low – battery level low, some features (e.g. software update) might stop working, please change battery soon – critical – battery level critical, device can fail any moment
        *   **battery\_level**: _(integer – minimum: 0 – maximum: 100)_
            
            The current battery state in percent, only for battery powered devices.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/zigbee\_connectivity

API to manage zigbee connectivity services. These are offered by zigbee connected devices.

#### [/resource/zigbee\_connectivity](#panel_resource_zigbee_connectivity) [get](#resource_zigbee_connectivity_get)

get

×

#### get /resource/zigbee\_connectivity

*   [Response](#resource_zigbee_connectivity_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZigbeeConnectivityGet)_
    
    **Items**: ZigbeeConnectivityGet
    
    *   **type**: _(zigbee\_connectivity)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of connected, disconnected, connectivity\_issue, unidirectional\_incoming)_
        
        Connected if device has been recently been available. When indicating connectivity issues the device is powered off or has network issues When indicating unidirectional incoming the device only talks to bridge
        
    *   **mac\_address**: _required(string – pattern: ^(\[0-9a-fA-F\]{2}:){7}\[0-9a-fA-F\]{2}$)_
    *   **channel**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **value**: _(one of channel\_11, channel\_15, channel\_20, channel\_25, not\_configured)_
            
            Current value of the zigbee channel. If recently changed, the value will reflect the channel that is currently being changed to.
            
    *   **extended\_pan\_id**: _(string – pattern: ^\[0-9a-f\]{16}$)_
        
        Extended pan id of the zigbee network.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/zigbee\_connectivity/{id}](#panel_resource_zigbee_connectivity__id_) [put](#resource_zigbee_connectivity__id__put) [get](#resource_zigbee_connectivity__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/zigbee\_connectivity/{id}

*   [Request](#resource_zigbee_connectivity__id__put_request)
*   [Response](#resource_zigbee_connectivity__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(zigbee\_connectivity)_
    
    Type of the supported resources
    
*   **channel**: _(object)_
    *   **value**: _(one of channel\_11, channel\_15, channel\_20, channel\_25, not\_configured)_
        
        Current value of the zigbee channel. If recently changed, the value will reflect the channel that is currently being changed to.
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/zigbee\_connectivity/{id}

*   [Request](#resource_zigbee_connectivity__id__get_request)
*   [Response](#resource_zigbee_connectivity__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZigbeeConnectivityGet)_
    
    **Items**: ZigbeeConnectivityGet
    
    *   **type**: _(zigbee\_connectivity)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of connected, disconnected, connectivity\_issue, unidirectional\_incoming)_
        
        Connected if device has been recently been available. When indicating connectivity issues the device is powered off or has network issues When indicating unidirectional incoming the device only talks to bridge
        
    *   **mac\_address**: _required(string – pattern: ^(\[0-9a-fA-F\]{2}:){7}\[0-9a-fA-F\]{2}$)_
    *   **channel**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **value**: _(one of channel\_11, channel\_15, channel\_20, channel\_25, not\_configured)_
            
            Current value of the zigbee channel. If recently changed, the value will reflect the channel that is currently being changed to.
            
    *   **extended\_pan\_id**: _(string – pattern: ^\[0-9a-f\]{16}$)_
        
        Extended pan id of the zigbee network.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/zgp\_connectivity

API to manage zgp connectivity services. These are offered by zigbee green power devices.

#### [/resource/zgp\_connectivity](#panel_resource_zgp_connectivity) [get](#resource_zgp_connectivity_get)

get

×

#### get /resource/zgp\_connectivity

*   [Response](#resource_zgp_connectivity_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZgpConnectivityGet)_
    
    **Items**: ZgpConnectivityGet
    
    *   **type**: _(zgp\_connectivity)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of connected, disconnected, connectivity\_issue, unidirectional\_incoming)_
        
        Connected if device has been recently been available. When indicating connectivity issues the device is powered off or has network issues When indicating unidirectional incoming the device only talks to bridge
        
    *   **source\_id**: _required(string)_
    *   **channel\_confirmed**: _(datetime)_
        
        timestamp of the last channel change confirmation
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/zgp\_connectivity/{id}](#panel_resource_zgp_connectivity__id_) [put](#resource_zgp_connectivity__id__put) [get](#resource_zgp_connectivity__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/zgp\_connectivity/{id}

*   [Request](#resource_zgp_connectivity__id__put_request)
*   [Response](#resource_zgp_connectivity__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(zgp\_connectivity)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/zgp\_connectivity/{id}

*   [Request](#resource_zgp_connectivity__id__get_request)
*   [Response](#resource_zgp_connectivity__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZgpConnectivityGet)_
    
    **Items**: ZgpConnectivityGet
    
    *   **type**: _(zgp\_connectivity)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of connected, disconnected, connectivity\_issue, unidirectional\_incoming)_
        
        Connected if device has been recently been available. When indicating connectivity issues the device is powered off or has network issues When indicating unidirectional incoming the device only talks to bridge
        
    *   **source\_id**: _required(string)_
    *   **channel\_confirmed**: _(datetime)_
        
        timestamp of the last channel change confirmation
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/zigbee\_device\_discovery

API to manage zigbee device discovery service. This is offered by the bridge for commissioning.

#### [/resource/zigbee\_device\_discovery](#panel_resource_zigbee_device_discovery) [get](#resource_zigbee_device_discovery_get)

get

×

#### get /resource/zigbee\_device\_discovery

*   [Response](#resource_zigbee_device_discovery_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZigbeeDeviceDiscoveryGet)_
    
    **Items**: ZigbeeDeviceDiscoveryGet
    
    *   **type**: _(zigbee\_device\_discovery)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of active, ready)_
    *   **action**: _required(object)_
        *   **action\_type\_values**: _required(array of SearchActionType)_
        *   **search\_codes**: _required(array of SearchCode – maxItems: 10)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/zigbee\_device\_discovery/{id}](#panel_resource_zigbee_device_discovery__id_) [put](#resource_zigbee_device_discovery__id__put) [get](#resource_zigbee_device_discovery__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/zigbee\_device\_discovery/{id}

*   [Request](#resource_zigbee_device_discovery__id__put_request)
*   [Response](#resource_zigbee_device_discovery__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(zigbee\_device\_discovery)_
    
    Type of the supported resources
    
*   **action**: _required(object)_
    *   **action\_type**: _required(one of search, search\_allow\_default\_link\_key)_
    *   **search\_codes**: _(array of SearchCode – maxItems: 10)_
*   **add\_install\_codes**: _(object)_
    *   **install\_codes**: _(array of InstallCode – minItems: 1 – maxItems: 50)_
        
        **Items**: InstallCode
        
        *   **mac\_address**: _required(string – pattern: ^(\[0-9a-fA-F\]{2}:){7}\[0-9a-fA-F\]{2}$)_
        *   **ic**: _required(string – pattern: ^\[A-F0-9\]{36}$)_
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/zigbee\_device\_discovery/{id}

*   [Request](#resource_zigbee_device_discovery__id__get_request)
*   [Response](#resource_zigbee_device_discovery__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ZigbeeDeviceDiscoveryGet)_
    
    **Items**: ZigbeeDeviceDiscoveryGet
    
    *   **type**: _(zigbee\_device\_discovery)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **status**: _required(one of active, ready)_
    *   **action**: _required(object)_
        *   **action\_type\_values**: _required(array of SearchActionType)_
        *   **search\_codes**: _required(array of SearchCode – maxItems: 10)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/motion

API to manage motion services. These are offered by devices with motion sensing capabilities.

#### [/resource/motion](#panel_resource_motion) [get](#resource_motion_get)

get

×

#### get /resource/motion

*   [Response](#resource_motion_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MotionGet)_
    
    **Items**: MotionGet
    
    *   **type**: _(motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    *   **sensitivity**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **sensitivity**: _required(integer)_
            
            Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
            
        *   **sensitivity\_max**: _(integer)_
            
            Maximum value of the sensitivity configuration attribute.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/motion/{id}](#panel_resource_motion__id_) [put](#resource_motion__id__put) [get](#resource_motion__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/motion/{id}

*   [Request](#resource_motion__id__put_request)
*   [Response](#resource_motion__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(motion)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    
*   **sensitivity**: _(object)_
    *   **sensitivity**: _(integer)_
        
        Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/motion/{id}

*   [Request](#resource_motion__id__get_request)
*   [Response](#resource_motion__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MotionGet)_
    
    **Items**: MotionGet
    
    *   **type**: _(motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    *   **sensitivity**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **sensitivity**: _required(integer)_
            
            Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
            
        *   **sensitivity\_max**: _(integer)_
            
            Maximum value of the sensitivity configuration attribute.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/service\_group

API to manage service group services. These are services that aggregate their distinct children into grouped services. For example, adding one or more motion services as children will result in a grouped\_motion service that aggregates the motions service report.

#### [/resource/service\_group](#panel_resource_service_group) [post](#resource_service_group_post) [get](#resource_service_group_get)

post

get

×

#### post /resource/service\_group

*   [Request](#resource_service_group_post_request)
*   [Response](#resource_service_group_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(service\_group)_
    
    Type of the supported resources
    
*   **children**: _required(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _required(object)_
    
    additional metadata including a user given name
    
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/service\_group

*   [Response](#resource_service_group_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ServiceGroupGet)_
    
    **Items**: ServiceGroupGet
    
    *   **type**: _(service\_group)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/service\_group/{id}](#panel_resource_service_group__id_) [delete](#resource_service_group__id__delete) [put](#resource_service_group__id__put) [get](#resource_service_group__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/service\_group/{id}

*   [Request](#resource_service_group__id__delete_request)
*   [Response](#resource_service_group__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/service\_group/{id}

*   [Request](#resource_service_group__id__put_request)
*   [Response](#resource_service_group__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(service\_group)_
    
    Type of the supported resources
    
*   **children**: _(array of ResourceIdentifier)_
    
    Child devices/services to group by the derived group
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    
*   **metadata**: _(object)_
    
    additional metadata including a user given name
    
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/service\_group/{id}

*   [Request](#resource_service_group__id__get_request)
*   [Response](#resource_service_group__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ServiceGroupGet)_
    
    **Items**: ServiceGroupGet
    
    *   **type**: _(service\_group)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **children**: _required(array of ResourceIdentifier)_
        
        Child devices/services to group by the derived group
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **services**: _required(array of ResourceIdentifier)_
        
        References all services aggregating control and state of children in the group. This includes all services grouped in the group hierarchy given by child relation This includes all services of a device grouped in the group hierarchy given by child relation Aggregation is per service type, ie every service type which can be grouped has a corresponding definition of grouped type Supported types: – grouped\_light – grouped\_motion – grouped\_light\_level
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    *   **metadata**: _required(object)_
        
        additional metadata including a user given name
        
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/grouped\_motion

API to manage grouped motion services. These are offered by service groups with archetype “sensor\_group”.

#### [/resource/grouped\_motion](#panel_resource_grouped_motion) [get](#resource_grouped_motion_get)

get

×

#### get /resource/grouped\_motion

*   [Response](#resource_grouped_motion_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedMotionGet)_
    
    **Items**: GroupedMotionGet
    
    *   **type**: _(grouped\_motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/grouped\_motion/{id}](#panel_resource_grouped_motion__id_) [put](#resource_grouped_motion__id__put) [get](#resource_grouped_motion__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/grouped\_motion/{id}

*   [Request](#resource_grouped_motion__id__put_request)
*   [Response](#resource_grouped_motion__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(grouped\_motion)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/grouped\_motion/{id}

*   [Request](#resource_grouped_motion__id__get_request)
*   [Response](#resource_grouped_motion__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedMotionGet)_
    
    **Items**: GroupedMotionGet
    
    *   **type**: _(grouped\_motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/grouped\_light\_level

API to manage grouped light-level services. These are offered by service groups with archetype “sensor\_group”.

#### [/resource/grouped\_light\_level](#panel_resource_grouped_light_level) [get](#resource_grouped_light_level_get)

get

×

#### get /resource/grouped\_light\_level

*   [Response](#resource_grouped_light_level_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedLightLevelGet)_
    
    **Items**: GroupedLightLevelGet
    
    *   **type**: _(grouped\_light\_level)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **light**: _required(object)_
        *   **light\_level**: _required(integer)_
            
            Deprecated. Moved to light\_level\_report/light\_level
            
        *   **light\_level\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in light\_level is valid
            
        *   **light\_level\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **light\_level**: _required(integer)_
                
                Light level in 10000\*log10(lux) +1 measured by sensor. Logarithmic scale used because the human eye adjusts to light levels and small changes at low lux levels are more noticeable than at high lux levels. This allows use of linear scale configuration sliders.
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/grouped\_light\_level/{id}](#panel_resource_grouped_light_level__id_) [put](#resource_grouped_light_level__id__put) [get](#resource_grouped_light_level__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/grouped\_light\_level/{id}

*   [Request](#resource_grouped_light_level__id__put_request)
*   [Response](#resource_grouped_light_level__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(grouped\_light\_level)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/grouped\_light\_level/{id}

*   [Request](#resource_grouped_light_level__id__get_request)
*   [Response](#resource_grouped_light_level__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GroupedLightLevelGet)_
    
    **Items**: GroupedLightLevelGet
    
    *   **type**: _(grouped\_light\_level)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **light**: _required(object)_
        *   **light\_level**: _required(integer)_
            
            Deprecated. Moved to light\_level\_report/light\_level
            
        *   **light\_level\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in light\_level is valid
            
        *   **light\_level\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **light\_level**: _required(integer)_
                
                Light level in 10000\*log10(lux) +1 measured by sensor. Logarithmic scale used because the human eye adjusts to light levels and small changes at low lux levels are more noticeable than at high lux levels. This allows use of linear scale configuration sliders.
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/camera\_motion

API to manage camera\_motion services. These are offered by devices with camera based motion sensing capabilities.

#### [/resource/camera\_motion](#panel_resource_camera_motion) [get](#resource_camera_motion_get)

get

×

#### get /resource/camera\_motion

*   [Response](#resource_camera_motion_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of CameraMotionGet)_
    
    **Items**: CameraMotionGet
    
    *   **type**: _(camera\_motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    *   **sensitivity**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **sensitivity**: _required(integer)_
            
            Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
            
        *   **sensitivity\_max**: _(integer)_
            
            Maximum value of the sensitivity configuration attribute.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/camera\_motion/{id}](#panel_resource_camera_motion__id_) [put](#resource_camera_motion__id__put) [get](#resource_camera_motion__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/camera\_motion/{id}

*   [Request](#resource_camera_motion__id__put_request)
*   [Response](#resource_camera_motion__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(camera\_motion)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    
*   **sensitivity**: _(object)_
    *   **sensitivity**: _(integer)_
        
        Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/camera\_motion/{id}

*   [Request](#resource_camera_motion__id__get_request)
*   [Response](#resource_camera_motion__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of CameraMotionGet)_
    
    **Items**: CameraMotionGet
    
    *   **type**: _(camera\_motion)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **motion**: _required(object)_
        *   **motion**: _required(boolean)_
            
            Deprecated. Moved to motion\_report/motion.
            
        *   **motion\_valid**: _required(boolean)_
            
            Deprecated. Motion is valid when motion\_report property is present, invalid when absent.
            
        *   **motion\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **motion**: _required(boolean)_
                
                true if motion is detected
                
    *   **sensitivity**: _(object)_
        *   **status**: _required(one of set, changing)_
        *   **sensitivity**: _required(integer)_
            
            Sensitivity of the sensor. Value in the range 0 to sensitivity\_max.
            
        *   **sensitivity\_max**: _(integer)_
            
            Maximum value of the sensitivity configuration attribute.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/temperature

API to manage temperature services. These are offered by devices with temperature sensing capabilities.

#### [/resource/temperature](#panel_resource_temperature) [get](#resource_temperature_get)

get

×

#### get /resource/temperature

*   [Response](#resource_temperature_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of TemperatureGet)_
    
    **Items**: TemperatureGet
    
    *   **type**: _(temperature)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **temperature**: _required(object)_
        *   **temperature**: _required(number)_
            
            Deprecated. Moved to Temperature\_report/temperature
            
        *   **temperature\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in temperature is valid
            
        *   **temperature\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **temperature**: _required(number)_
                
                Temperature in 1.00 degrees Celsius
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/temperature/{id}](#panel_resource_temperature__id_) [put](#resource_temperature__id__put) [get](#resource_temperature__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/temperature/{id}

*   [Request](#resource_temperature__id__put_request)
*   [Response](#resource_temperature__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(temperature)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/temperature/{id}

*   [Request](#resource_temperature__id__get_request)
*   [Response](#resource_temperature__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of TemperatureGet)_
    
    **Items**: TemperatureGet
    
    *   **type**: _(temperature)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **temperature**: _required(object)_
        *   **temperature**: _required(number)_
            
            Deprecated. Moved to Temperature\_report/temperature
            
        *   **temperature\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in temperature is valid
            
        *   **temperature\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **temperature**: _required(number)_
                
                Temperature in 1.00 degrees Celsius
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/light\_level

API to manage light level services. These are offered by devices with light level sensing capabilities.

#### [/resource/light\_level](#panel_resource_light_level) [get](#resource_light_level_get)

get

×

#### get /resource/light\_level

*   [Response](#resource_light_level_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of LightLevelGet)_
    
    **Items**: LightLevelGet
    
    *   **type**: _(light\_level)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **light**: _required(object)_
        *   **light\_level**: _required(integer)_
            
            Deprecated. Moved to light\_level\_report/light\_level
            
        *   **light\_level\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in light\_level is valid
            
        *   **light\_level\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **light\_level**: _required(integer)_
                
                Light level in 10000\*log10(lux) +1 measured by sensor. Logarithmic scale used because the human eye adjusts to light levels and small changes at low lux levels are more noticeable than at high lux levels. This allows use of linear scale configuration sliders.
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/light\_level/{id}](#panel_resource_light_level__id_) [put](#resource_light_level__id__put) [get](#resource_light_level__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/light\_level/{id}

*   [Request](#resource_light_level__id__put_request)
*   [Response](#resource_light_level__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(light\_level)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/light\_level/{id}

*   [Request](#resource_light_level__id__get_request)
*   [Response](#resource_light_level__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of LightLevelGet)_
    
    **Items**: LightLevelGet
    
    *   **type**: _(light\_level)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **light**: _required(object)_
        *   **light\_level**: _required(integer)_
            
            Deprecated. Moved to light\_level\_report/light\_level
            
        *   **light\_level\_valid**: _required(boolean)_
            
            Deprecated. Indication whether the value presented in light\_level is valid
            
        *   **light\_level\_report**: _(object)_
            *   **changed**: _required(datetime)_
                
                last time the value of this property is changed.
                
            *   **light\_level**: _required(integer)_
                
                Light level in 10000\*log10(lux) +1 measured by sensor. Logarithmic scale used because the human eye adjusts to light levels and small changes at low lux levels are more noticeable than at high lux levels. This allows use of linear scale configuration sliders.
                
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/button

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

#### [/resource/button](#panel_resource_button) [get](#resource_button_get)

get

×

#### get /resource/button

*   [Response](#resource_button_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ButtonGet)_
    
    **Items**: ButtonGet
    
    *   **type**: _(button)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **metadata**: _required(object)_
        
        Metadata describing this resource
        
        *   **control\_id**: _required(integer – minimum: 0 – maximum: 8)_
            
            control identifier of the switch which is unique per device. Meaning in combination with type – dots Number of dots – number Number printed on device – other a logical order of controls in switch
            
    *   **button**: _required(object)_
        *   **last\_event**: _(one of initial\_press, repeat, short\_release, long\_release, double\_short\_release, long\_press)_
            
            Deprecated. Move to button\_report/event
            
        *   **button\_report**: _(object)_
            *   **updated**: _required(datetime)_
                
                last time the value of this property is updated.
                
            *   **event**: _required(one of initial\_press, repeat, short\_release, long\_release, double\_short\_release, long\_press)_
                
                event which can be send by a button control
                
        *   **repeat\_interval**: _(integer)_
            
            Duration of a light transition or timed effects in ms.
            
        *   **event\_values**: _(array of ButtonEvent)_
            
            list of all button events that this device supports
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/button/{id}](#panel_resource_button__id_) [put](#resource_button__id__put) [get](#resource_button__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/button/{id}

*   [Request](#resource_button__id__put_request)
*   [Response](#resource_button__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(button)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/button/{id}

*   [Request](#resource_button__id__get_request)
*   [Response](#resource_button__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ButtonGet)_
    
    **Items**: ButtonGet
    
    *   **type**: _(button)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **metadata**: _required(object)_
        
        Metadata describing this resource
        
        *   **control\_id**: _required(integer – minimum: 0 – maximum: 8)_
            
            control identifier of the switch which is unique per device. Meaning in combination with type – dots Number of dots – number Number printed on device – other a logical order of controls in switch
            
    *   **button**: _required(object)_
        *   **last\_event**: _(one of initial\_press, repeat, short\_release, long\_release, double\_short\_release, long\_press)_
            
            Deprecated. Move to button\_report/event
            
        *   **button\_report**: _(object)_
            *   **updated**: _required(datetime)_
                
                last time the value of this property is updated.
                
            *   **event**: _required(one of initial\_press, repeat, short\_release, long\_release, double\_short\_release, long\_press)_
                
                event which can be send by a button control
                
        *   **repeat\_interval**: _(integer)_
            
            Duration of a light transition or timed effects in ms.
            
        *   **event\_values**: _(array of ButtonEvent)_
            
            list of all button events that this device supports
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/relative\_rotary

API to manage relative rotary services. These are offered by devices with rotary capabilities.

#### [/resource/relative\_rotary](#panel_resource_relative_rotary) [get](#resource_relative_rotary_get)

get

×

#### get /resource/relative\_rotary

*   [Response](#resource_relative_rotary_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of RelativeRotaryGet)_
    
    **Items**: RelativeRotaryGet
    
    *   **type**: _(relative\_rotary)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **relative\_rotary**: _required(object)_
        *   **last\_event**: _(object)_
            
            Deprecated. Renamed to RelativeRotaryReport. Indicate which type of rotary event is received
            
            *   **action**: _required(one of start, repeat)_
                
                Indicate which type of rotary event is received
                
            *   **rotation**: _required(object)_
                *   **direction**: _required(one of clock\_wise, counter\_clock\_wise)_
                    
                    A rotation opposite to the previous rotation, will always start with new start command.
                    
                *   **steps**: _required(integer – minimum: 0 – maximum: 32767)_
                    
                    amount of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. Resolution = 1000 steps / 360 degree rotation.
                    
                *   **duration**: _required(integer – minimum: 0 – maximum: 65534)_
                    
                    duration of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. duration is specified in miliseconds.
                    
        *   **rotary\_report**: _(object)_
            *   **updated**: _required(datetime)_
                
                last time the value of this property is updated.
                
            *   **action**: _required(one of start, repeat)_
                
                Indicate which type of rotary event is received
                
            *   **rotation**: _required(object)_
                *   **direction**: _required(one of clock\_wise, counter\_clock\_wise)_
                    
                    A rotation opposite to the previous rotation, will always start with new start command.
                    
                *   **steps**: _required(integer – minimum: 0 – maximum: 32767)_
                    
                    amount of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. Resolution = 1000 steps / 360 degree rotation.
                    
                *   **duration**: _required(integer – minimum: 0 – maximum: 65534)_
                    
                    duration of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. duration is specified in miliseconds.
                    
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/relative\_rotary/{id}](#panel_resource_relative_rotary__id_) [put](#resource_relative_rotary__id__put) [get](#resource_relative_rotary__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/relative\_rotary/{id}

*   [Request](#resource_relative_rotary__id__put_request)
*   [Response](#resource_relative_rotary__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(relative\_rotary)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/relative\_rotary/{id}

*   [Request](#resource_relative_rotary__id__get_request)
*   [Response](#resource_relative_rotary__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of RelativeRotaryGet)_
    
    **Items**: RelativeRotaryGet
    
    *   **type**: _(relative\_rotary)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **relative\_rotary**: _required(object)_
        *   **last\_event**: _(object)_
            
            Deprecated. Renamed to RelativeRotaryReport. Indicate which type of rotary event is received
            
            *   **action**: _required(one of start, repeat)_
                
                Indicate which type of rotary event is received
                
            *   **rotation**: _required(object)_
                *   **direction**: _required(one of clock\_wise, counter\_clock\_wise)_
                    
                    A rotation opposite to the previous rotation, will always start with new start command.
                    
                *   **steps**: _required(integer – minimum: 0 – maximum: 32767)_
                    
                    amount of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. Resolution = 1000 steps / 360 degree rotation.
                    
                *   **duration**: _required(integer – minimum: 0 – maximum: 65534)_
                    
                    duration of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. duration is specified in miliseconds.
                    
        *   **rotary\_report**: _(object)_
            *   **updated**: _required(datetime)_
                
                last time the value of this property is updated.
                
            *   **action**: _required(one of start, repeat)_
                
                Indicate which type of rotary event is received
                
            *   **rotation**: _required(object)_
                *   **direction**: _required(one of clock\_wise, counter\_clock\_wise)_
                    
                    A rotation opposite to the previous rotation, will always start with new start command.
                    
                *   **steps**: _required(integer – minimum: 0 – maximum: 32767)_
                    
                    amount of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. Resolution = 1000 steps / 360 degree rotation.
                    
                *   **duration**: _required(integer – minimum: 0 – maximum: 65534)_
                    
                    duration of rotation since previous event in case of repeat, amount of rotation since start in case of a start\_event. duration is specified in miliseconds.
                    
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/behavior\_script

API to discover available scripts that can be instantiated

#### [/resource/behavior\_script](#panel_resource_behavior_script) [get](#resource_behavior_script_get)

get

×

#### get /resource/behavior\_script

*   [Response](#resource_behavior_script_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BehaviorScriptGet)_
    
    **Items**: BehaviorScriptGet
    
    *   **type**: _(behavior\_script)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **description**: _required(string)_
        
        Short description of script.
        
    *   **configuration\_schema**: _required(object)_
        
        JSON schema object used for validating ScriptInstance.configuration property.
        
    *   **trigger\_schema**: _required(object)_
        
        JSON schema object used for validating ScriptInstance.trigger property.
        
    *   **state\_schema**: _required(object)_
        
        JSON schema of ScriptInstance.state property.
        
    *   **version**: _required(string – pattern: ^\[1-9\]\[0-9\]{0,2}(\[.\]\[0-9\]{1,3}){1,2})_
        
        Version of script.
        
    *   **metadata**: _required(object)_
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **category**: _required(one of automation, entertainment, accessory, other)_
    *   **supported\_features**: _(array of string)_
        
        Features that the script supports.
        
    *   **max\_number\_instances**: _(integer – minimum: 0 – maximum: 255)_
        
        Max number of script instances.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/behavior\_script/{id}](#panel_resource_behavior_script__id_) [get](#resource_behavior_script__id__get)

API calls for resource which can be just retrieved (GET on resource instance)

get

×

#### get /resource/behavior\_script/{id}

*   [Request](#resource_behavior_script__id__get_request)
*   [Response](#resource_behavior_script__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BehaviorScriptGet)_
    
    **Items**: BehaviorScriptGet
    
    *   **type**: _(behavior\_script)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **description**: _required(string)_
        
        Short description of script.
        
    *   **configuration\_schema**: _required(object)_
        
        JSON schema object used for validating ScriptInstance.configuration property.
        
    *   **trigger\_schema**: _required(object)_
        
        JSON schema object used for validating ScriptInstance.trigger property.
        
    *   **state\_schema**: _required(object)_
        
        JSON schema of ScriptInstance.state property.
        
    *   **version**: _required(string – pattern: ^\[1-9\]\[0-9\]{0,2}(\[.\]\[0-9\]{1,3}){1,2})_
        
        Version of script.
        
    *   **metadata**: _required(object)_
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **category**: _required(one of automation, entertainment, accessory, other)_
    *   **supported\_features**: _(array of string)_
        
        Features that the script supports.
        
    *   **max\_number\_instances**: _(integer – minimum: 0 – maximum: 255)_
        
        Max number of script instances.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/behavior\_instance

API to manage instances of script

#### [/resource/behavior\_instance](#panel_resource_behavior_instance) [post](#resource_behavior_instance_post) [get](#resource_behavior_instance_get)

post

get

×

#### post /resource/behavior\_instance

*   [Request](#resource_behavior_instance_post_request)
*   [Response](#resource_behavior_instance_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(behavior\_instance)_
    
    Type of the supported resources
    
*   **script\_id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
    
    Identifier to ScriptDefinition.
    
*   **enabled**: _required(boolean)_
    
    Indicated whether a scripts is enabled.
    
*   **configuration**: _required(object)_
    
    Script configuration. This property is validated using ScriptDefinition.configuration\_schema JSON schema.
    
*   **metadata**: _(object)_
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
*   **migrated\_from**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
    
    Clip v1 resource identifier
    

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/behavior\_instance

*   [Response](#resource_behavior_instance_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BehaviorInstanceGet)_
    
    **Items**: BehaviorInstanceGet
    
    *   **type**: _(behavior\_instance)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **script\_id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Identifier to ScriptDefinition.
        
    *   **enabled**: _required(boolean)_
        
        Indicated whether a scripts is enabled.
        
    *   **state**: _(object)_
        
        Script instance state. This read-only property is according to ScriptDefinition.state\_schema JSON schema.
        
    *   **configuration**: _required(object)_
        
        Script configuration. This property is validated using ScriptDefinition.configuration\_schema JSON schema.
        
    *   **dependees**: _required(array of ResourceDependee)_
        
        Represents all resources which this instance depends on.
        
        **Items**: ResourceDependee
        
        *   **type**: _(string)_
        *   **target**: _required(object)_
            
            Id of the dependency resource (target).
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **level**: _required(critical)_
            
            #- non\_critical: Defines a dependency between resources: although source is impacted by removal of target, source remains of target means removal of source.
            
            *   critical: Defines a critical dependency between resources: source cannot function without target, hence removal of target means removal of source.
        
    *   **status**: _required(one of initializing, running, disabled, errored)_
        
        Script status. If the script is in the errored state then check errors for more details about the error.
        
    *   **last\_error**: _required(string)_
        
        Last error happened while executing the script.
        
    *   **metadata**: _required(object)_
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
    *   **migrated\_from**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/behavior\_instance/{id}](#panel_resource_behavior_instance__id_) [delete](#resource_behavior_instance__id__delete) [put](#resource_behavior_instance__id__put) [get](#resource_behavior_instance__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/behavior\_instance/{id}

*   [Request](#resource_behavior_instance__id__delete_request)
*   [Response](#resource_behavior_instance__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/behavior\_instance/{id}

*   [Request](#resource_behavior_instance__id__put_request)
*   [Response](#resource_behavior_instance__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(behavior\_instance)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    Indicated whether a scripts is enabled.
    
*   **configuration**: _(object)_
    
    Script configuration. This property is validated using ScriptDefinition.configuration\_schema JSON schema.
    
*   **trigger**: _(object)_
    
    Action that needs to be taken by this script instance. This property is validated using ScriptDefinition.trigger\_schema JSON schema.
    
*   **metadata**: _(object)_
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/behavior\_instance/{id}

*   [Request](#resource_behavior_instance__id__get_request)
*   [Response](#resource_behavior_instance__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of BehaviorInstanceGet)_
    
    **Items**: BehaviorInstanceGet
    
    *   **type**: _(behavior\_instance)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **script\_id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Identifier to ScriptDefinition.
        
    *   **enabled**: _required(boolean)_
        
        Indicated whether a scripts is enabled.
        
    *   **state**: _(object)_
        
        Script instance state. This read-only property is according to ScriptDefinition.state\_schema JSON schema.
        
    *   **configuration**: _required(object)_
        
        Script configuration. This property is validated using ScriptDefinition.configuration\_schema JSON schema.
        
    *   **dependees**: _required(array of ResourceDependee)_
        
        Represents all resources which this instance depends on.
        
        **Items**: ResourceDependee
        
        *   **type**: _(string)_
        *   **target**: _required(object)_
            
            Id of the dependency resource (target).
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **level**: _required(critical)_
            
            #- non\_critical: Defines a dependency between resources: although source is impacted by removal of target, source remains of target means removal of source.
            
            *   critical: Defines a critical dependency between resources: source cannot function without target, hence removal of target means removal of source.
        
    *   **status**: _required(one of initializing, running, disabled, errored)_
        
        Script status. If the script is in the errored state then check errors for more details about the error.
        
    *   **last\_error**: _required(string)_
        
        Last error happened while executing the script.
        
    *   **metadata**: _required(object)_
        *   **name**: _(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
    *   **migrated\_from**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/geofence\_client

API for geofencing functionality

#### [/resource/geofence\_client](#panel_resource_geofence_client) [post](#resource_geofence_client_post) [get](#resource_geofence_client_get)

post

get

×

#### post /resource/geofence\_client

*   [Request](#resource_geofence_client_post_request)
*   [Response](#resource_geofence_client_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(geofence\_client)_
    
    Type of the supported resources
    
*   **is\_at\_home**: _(boolean)_
    
    Indicator if Geofence Client is at home.
    
*   **name**: _(string – minLength: 1 – maxLength: 32)_

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/geofence\_client

*   [Response](#resource_geofence_client_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GeofenceClientGet)_
    
    **Items**: GeofenceClientGet
    
    *   **type**: _(geofence\_client)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/geofence\_client/{id}](#panel_resource_geofence_client__id_) [delete](#resource_geofence_client__id__delete) [put](#resource_geofence_client__id__put) [get](#resource_geofence_client__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/geofence\_client/{id}

*   [Request](#resource_geofence_client__id__delete_request)
*   [Response](#resource_geofence_client__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/geofence\_client/{id}

*   [Request](#resource_geofence_client__id__put_request)
*   [Response](#resource_geofence_client__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(geofence\_client)_
    
    Type of the supported resources
    
*   **is\_at\_home**: _(boolean)_
    
    Indicator if Geofence Client is at home.
    
*   **name**: _(string – minLength: 1 – maxLength: 32)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/geofence\_client/{id}

*   [Request](#resource_geofence_client__id__get_request)
*   [Response](#resource_geofence_client__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GeofenceClientGet)_
    
    **Items**: GeofenceClientGet
    
    *   **type**: _(geofence\_client)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/geolocation

API for setting the geolocation

#### [/resource/geolocation](#panel_resource_geolocation) [get](#resource_geolocation_get)

get

×

#### get /resource/geolocation

*   [Response](#resource_geolocation_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GeolocationGet)_
    
    **Items**: GeolocationGet
    
    *   **type**: _(geolocation)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **is\_configured**: _required(boolean – default: false)_
        
        is the geolocation configured
        
    *   **sun\_today**: _(object)_
        
        Info related to today's sun (only available when geolocation has been configured)
        
        *   **sunset\_time**: _required(time-only)_
            
            time of day at sunset (in local time, and only valid on normal days, see property day\_type)
            
        *   **day\_type**: _required(one of normal\_day, polar\_day, polar\_night)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/geolocation/{id}](#panel_resource_geolocation__id_) [put](#resource_geolocation__id__put) [get](#resource_geolocation__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/geolocation/{id}

*   [Request](#resource_geolocation__id__put_request)
*   [Response](#resource_geolocation__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(geolocation)_
    
    Type of the supported resources
    
*   **longitude**: _required(number – minimum: -180 – maximum: 180)_
    
    longitude
    
*   **latitude**: _required(number – minimum: -90 – maximum: 90)_
    
    latitude
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/geolocation/{id}

*   [Request](#resource_geolocation__id__get_request)
*   [Response](#resource_geolocation__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of GeolocationGet)_
    
    **Items**: GeolocationGet
    
    *   **type**: _(geolocation)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **is\_configured**: _required(boolean – default: false)_
        
        is the geolocation configured
        
    *   **sun\_today**: _(object)_
        
        Info related to today's sun (only available when geolocation has been configured)
        
        *   **sunset\_time**: _required(time-only)_
            
            time of day at sunset (in local time, and only valid on normal days, see property day\_type)
            
        *   **day\_type**: _required(one of normal\_day, polar\_day, polar\_night)_
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/entertainment\_configuration

API to manage entertainment configurations, used for Hue Entertainment functionality

#### [/resource/entertainment\_configuration](#panel_resource_entertainment_configuration) [post](#resource_entertainment_configuration_post) [get](#resource_entertainment_configuration_get)

post

get

×

#### post /resource/entertainment\_configuration

*   [Request](#resource_entertainment_configuration_post_request)
*   [Response](#resource_entertainment_configuration_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(entertainment\_configuration)_
    
    Type of the supported resources
    
*   **metadata**: _required(object)_
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Friendly name of the entertainment configuration
        
*   **configuration\_type**: _required(one of screen, monitor, music, 3dspace, other)_
    
    Defines for which type of application this channel assignment was optimized for “screen”: Channels are organized around content from a screen “monitor”: Channels are organized around content from one or several monitors “music”: Channels are organized for music synchronization “3dspace: Channels are organized to provide 3d spacial effects “other”: General use case
    
*   **stream\_proxy**: _(object)_
    *   **mode**: _required(one of auto, manual)_
        
        Proxymode used for this group
        
        *   auto – The bridge will select a proxynode automatically. – manual – The proxynode has been set manually
    *   **node**: _(object)_
        
        Reference to the device acting as proxy The proxynode relays the entertainment traffic and should be located in or close to all entertainment lamps in this group. The proxynode set by the application (manual) resp selected by the bridge (auto). Writing sets proxymode to “manual”. Is not allowed to be combined with attribute “proxymode”:”auto” Can be type BridgeDevice or ZigbeeDevice
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
*   **locations**: _required(object)_
    
    Entertainment services of the lights that are in the zone have locations
    
    *   **service\_locations**: _required(array of ServiceLocationPost)_
        
        **Items**: ServiceLocationPost
        
        *   **service**: _required(object)_
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **positions**: _required(array of Position – minItems: 1 – maxItems: 2)_
            
            Describes the location of the service.
            
            **Items**: Position
            
            *   **x**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **y**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **z**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            
        

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/entertainment\_configuration

*   [Response](#resource_entertainment_configuration_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of EntertainmentConfigurationGet)_
    
    **Items**: EntertainmentConfigurationGet
    
    *   **type**: _(entertainment\_configuration)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Friendly name of the entertainment configuration
            
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Friendly name of the entertainment configuration Deprecated: use metadata/name
        
    *   **configuration\_type**: _required(one of screen, monitor, music, 3dspace, other)_
        
        Defines for which type of application this channel assignment was optimized for “screen”: Channels are organized around content from a screen “monitor”: Channels are organized around content from one or several monitors “music”: Channels are organized for music synchronization “3dspace: Channels are organized to provide 3d spacial effects “other”: General use case
        
    *   **status**: _required(one of active, inactive)_
        
        Read only field reporting if the stream is active or not
        
    *   **active\_streamer**: _(object)_
        
        Expected value is of a ResourceIdentifier of the type auth\_v1 i.e. an application id, only available if status is active
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **stream\_proxy**: _required(object)_
        *   **mode**: _required(one of auto, manual)_
            
            Proxymode used for this group
            
            *   auto – The bridge will select a proxynode automatically. – manual – The proxynode has been set manually
        *   **node**: _required(object)_
            
            Reference to the device acting as proxy The proxynode relays the entertainment traffic and should be located in or close to all entertainment lamps in this group. The proxynode set by the application (manual) resp selected by the bridge (auto). Writing sets proxymode to “manual”. Is not allowed to be combined with attribute “proxymode”:”auto” Can be type BridgeDevice or ZigbeeDevice
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
    *   **channels**: _required(array of EntertainmentChannelGet)_
        
        Holds the channels. Each channel groups segments of one or different light
        
        **Items**: EntertainmentChannelGet
        
        *   **channel\_id**: _required(integer – minimum: 0 – maximum: 255)_
            
            Bridge assigns a number upon creation. This is the number to be used by the HueStream API when addressing the channel
            
        *   **position**: _required(object)_
            
            xyz position of this channel. It is the average position of its members
            
            *   **x**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **y**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **z**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
        *   **members**: _required(array of SegmentReference)_
            
            List that references segments that are members of that channel
            
            **Items**: SegmentReference
            
            *   **service**: _required(object)_
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            *   **index**: _required(integer)_
            
        
    *   **locations**: _required(object)_
        
        Entertainment services of the lights that are in the zone have locations
        
        *   **service\_locations**: _required(array of ServiceLocationGet)_
            
            **Items**: ServiceLocationGet
            
            *   **service**: _required(object)_
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            *   **position**: _(object)_
                
                Describes the location of the service. Deprecated: use positions
                
                *   **x**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **y**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **z**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
            *   **positions**: _required(array of Position – minItems: 1 – maxItems: 2)_
                
                Describes the location of the service.
                
                **Items**: Position
                
                *   **x**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **y**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **z**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                
            *   **equalization\_factor**: _required(number – default: 1 – maximum: 1)_
                
                Relative equalization factor applied to the entertainment service, to compensate for differences in brightness in the entertainment configuration. Value cannot be 0, writing 0 changes it to lowest possible value.
                
            
    *   **light\_services**: _(array of ResourceIdentifier)_
        
        List of light services that belong to this entertainment configuration Deprecated: resolve via entertainment services in locations object
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/entertainment\_configuration/{id}](#panel_resource_entertainment_configuration__id_) [delete](#resource_entertainment_configuration__id__delete) [put](#resource_entertainment_configuration__id__put) [get](#resource_entertainment_configuration__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/entertainment\_configuration/{id}

*   [Request](#resource_entertainment_configuration__id__delete_request)
*   [Response](#resource_entertainment_configuration__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/entertainment\_configuration/{id}

*   [Request](#resource_entertainment_configuration__id__put_request)
*   [Response](#resource_entertainment_configuration__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(entertainment\_configuration)_
    
    Type of the supported resources
    
*   **metadata**: _(object)_
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Friendly name of the entertainment configuration
        
*   **configuration\_type**: _(one of screen, monitor, music, 3dspace, other)_
    
    Defines for which type of application this channel assignment was optimized for “screen”: Channels are organized around content from a screen “monitor”: Channels are organized around content from one or several monitors “music”: Channels are organized for music synchronization “3dspace: Channels are organized to provide 3d spacial effects “other”: General use case
    
*   **action**: _(one of start, stop)_
    
    If status is “inactive” -> write start to start streaming. Writing start when it's already active does not change the owership of the streaming. If status is “active” -> write “stop” to end the current streaming. In order to start streaming when other application is already streaming first write “stop” and then “start”
    
*   **stream\_proxy**: _(object)_
    *   **mode**: _required(one of auto, manual)_
        
        Proxymode used for this group
        
        *   auto – The bridge will select a proxynode automatically. – manual – The proxynode has been set manually
    *   **node**: _(object)_
        
        Reference to the device acting as proxy The proxynode relays the entertainment traffic and should be located in or close to all entertainment lamps in this group. The proxynode set by the application (manual) resp selected by the bridge (auto). Writing sets proxymode to “manual”. Is not allowed to be combined with attribute “proxymode”:”auto” Can be type BridgeDevice or ZigbeeDevice
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
*   **locations**: _(object)_
    
    Entertainment services of the lights that are in the zone have locations
    
    *   **service\_locations**: _required(array of ServiceLocationPut)_
        
        **Items**: ServiceLocationPut
        
        *   **service**: _required(object)_
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **positions**: _required(array of Position – minItems: 1 – maxItems: 2)_
            
            Describes the location of the service.
            
            **Items**: Position
            
            *   **x**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **y**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **z**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            
        *   **equalization\_factor**: _(number – default: 1 – maximum: 1)_
            
            Relative equalization factor applied to the entertainment service, to compensate for differences in brightness in the entertainment configuration. Value cannot be 0, writing 0 changes it to lowest possible value.
            
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/entertainment\_configuration/{id}

*   [Request](#resource_entertainment_configuration__id__get_request)
*   [Response](#resource_entertainment_configuration__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of EntertainmentConfigurationGet)_
    
    **Items**: EntertainmentConfigurationGet
    
    *   **type**: _(entertainment\_configuration)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Friendly name of the entertainment configuration
            
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Friendly name of the entertainment configuration Deprecated: use metadata/name
        
    *   **configuration\_type**: _required(one of screen, monitor, music, 3dspace, other)_
        
        Defines for which type of application this channel assignment was optimized for “screen”: Channels are organized around content from a screen “monitor”: Channels are organized around content from one or several monitors “music”: Channels are organized for music synchronization “3dspace: Channels are organized to provide 3d spacial effects “other”: General use case
        
    *   **status**: _required(one of active, inactive)_
        
        Read only field reporting if the stream is active or not
        
    *   **active\_streamer**: _(object)_
        
        Expected value is of a ResourceIdentifier of the type auth\_v1 i.e. an application id, only available if status is active
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **stream\_proxy**: _required(object)_
        *   **mode**: _required(one of auto, manual)_
            
            Proxymode used for this group
            
            *   auto – The bridge will select a proxynode automatically. – manual – The proxynode has been set manually
        *   **node**: _required(object)_
            
            Reference to the device acting as proxy The proxynode relays the entertainment traffic and should be located in or close to all entertainment lamps in this group. The proxynode set by the application (manual) resp selected by the bridge (auto). Writing sets proxymode to “manual”. Is not allowed to be combined with attribute “proxymode”:”auto” Can be type BridgeDevice or ZigbeeDevice
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
    *   **channels**: _required(array of EntertainmentChannelGet)_
        
        Holds the channels. Each channel groups segments of one or different light
        
        **Items**: EntertainmentChannelGet
        
        *   **channel\_id**: _required(integer – minimum: 0 – maximum: 255)_
            
            Bridge assigns a number upon creation. This is the number to be used by the HueStream API when addressing the channel
            
        *   **position**: _required(object)_
            
            xyz position of this channel. It is the average position of its members
            
            *   **x**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **y**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
            *   **z**: _required(number – minimum: -1 – maximum: 1)_
                
                Coordinate of a single axis
                
        *   **members**: _required(array of SegmentReference)_
            
            List that references segments that are members of that channel
            
            **Items**: SegmentReference
            
            *   **service**: _required(object)_
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            *   **index**: _required(integer)_
            
        
    *   **locations**: _required(object)_
        
        Entertainment services of the lights that are in the zone have locations
        
        *   **service\_locations**: _required(array of ServiceLocationGet)_
            
            **Items**: ServiceLocationGet
            
            *   **service**: _required(object)_
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            *   **position**: _(object)_
                
                Describes the location of the service. Deprecated: use positions
                
                *   **x**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **y**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **z**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
            *   **positions**: _required(array of Position – minItems: 1 – maxItems: 2)_
                
                Describes the location of the service.
                
                **Items**: Position
                
                *   **x**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **y**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                *   **z**: _required(number – minimum: -1 – maximum: 1)_
                    
                    Coordinate of a single axis
                    
                
            *   **equalization\_factor**: _required(number – default: 1 – maximum: 1)_
                
                Relative equalization factor applied to the entertainment service, to compensate for differences in brightness in the entertainment configuration. Value cannot be 0, writing 0 changes it to lowest possible value.
                
            
    *   **light\_services**: _(array of ResourceIdentifier)_
        
        List of light services that belong to this entertainment configuration Deprecated: resolve via entertainment services in locations object
        
        **Items**: ResourceIdentifier
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/entertainment

API to manage entertainment services. These are offered by devices with color lighting capabilities.

#### [/resource/entertainment](#panel_resource_entertainment) [get](#resource_entertainment_get)

get

×

#### get /resource/entertainment

*   [Response](#resource_entertainment_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of EntertainmentGet)_
    
    **Items**: EntertainmentGet
    
    *   **type**: _(entertainment)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **renderer**: _required(boolean)_
        
        Indicates if a lamp can be used for entertainment streaming as renderer
        
    *   **renderer\_reference**: _(object)_
        
        Indicates which light service is linked to this entertainment service
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **proxy**: _required(boolean)_
        
        Indicates if a lamp can be used for entertainment streaming as a proxy node
        
    *   **equalizer**: _required(boolean)_
        
        Indicates if a lamp can handle the equalization factor to dimming maximum brightness in a stream
        
    *   **max\_streams**: _(integer – minimum: 1)_
        
        Indicates the maximum number of parallel streaming sessions the bridge supports
        
    *   **segments**: _(object)_
        
        Holds all parameters concerning the segmentations capabilities of a device
        
        *   **configurable**: _required(boolean)_
            
            Defines if the segmentation of the device are configurable or not
            
        *   **max\_segments**: _required(integer – minimum: 1)_
        *   **segments**: _required(array of Segment – minItems: 1)_
            
            Contains the segments configuration of the device for entertainment purposes. A device can be segmented in a single way
            
            **Items**: Segment
            
            *   **start**: _required(integer – minimum: 0)_
            *   **length**: _required(integer – minimum: 1)_
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/entertainment/{id}](#panel_resource_entertainment__id_) [put](#resource_entertainment__id__put) [get](#resource_entertainment__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/entertainment/{id}

*   [Request](#resource_entertainment__id__put_request)
*   [Response](#resource_entertainment__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(entertainment)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/entertainment/{id}

*   [Request](#resource_entertainment__id__get_request)
*   [Response](#resource_entertainment__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of EntertainmentGet)_
    
    **Items**: EntertainmentGet
    
    *   **type**: _(entertainment)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **renderer**: _required(boolean)_
        
        Indicates if a lamp can be used for entertainment streaming as renderer
        
    *   **renderer\_reference**: _(object)_
        
        Indicates which light service is linked to this entertainment service
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **proxy**: _required(boolean)_
        
        Indicates if a lamp can be used for entertainment streaming as a proxy node
        
    *   **equalizer**: _required(boolean)_
        
        Indicates if a lamp can handle the equalization factor to dimming maximum brightness in a stream
        
    *   **max\_streams**: _(integer – minimum: 1)_
        
        Indicates the maximum number of parallel streaming sessions the bridge supports
        
    *   **segments**: _(object)_
        
        Holds all parameters concerning the segmentations capabilities of a device
        
        *   **configurable**: _required(boolean)_
            
            Defines if the segmentation of the device are configurable or not
            
        *   **max\_segments**: _required(integer – minimum: 1)_
        *   **segments**: _required(array of Segment – minItems: 1)_
            
            Contains the segments configuration of the device for entertainment purposes. A device can be segmented in a single way
            
            **Items**: Segment
            
            *   **start**: _required(integer – minimum: 0)_
            *   **length**: _required(integer – minimum: 1)_
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/homekit

API to manage homekit service

#### [/resource/homekit](#panel_resource_homekit) [get](#resource_homekit_get)

get

×

#### get /resource/homekit

*   [Response](#resource_homekit_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of HomekitGet)_
    
    **Items**: HomekitGet
    
    *   **type**: _(homekit)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **status**: _required(one of paired, pairing, unpaired)_
        
        Read only field indicating whether homekit is already paired, currently open for pairing, or unpaired. Transitions: – unpaired > pairing – pushlink button press or power cycle – pairing > paired – through HAP – pairing > unpaired – 10 minutes – paired > unpaired – homekit reset.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/homekit/{id}](#panel_resource_homekit__id_) [put](#resource_homekit__id__put) [get](#resource_homekit__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/homekit/{id}

*   [Request](#resource_homekit__id__put_request)
*   [Response](#resource_homekit__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(homekit)_
    
    Type of the supported resources
    
*   **action**: _(homekit\_reset)_
    
    Reset homekit, including removing all pairings and reset state and Bonjour service to factory settings. The Homekit will start functioning after approximately 10 seconds.
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/homekit/{id}

*   [Request](#resource_homekit__id__get_request)
*   [Response](#resource_homekit__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of HomekitGet)_
    
    **Items**: HomekitGet
    
    *   **type**: _(homekit)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **status**: _required(one of paired, pairing, unpaired)_
        
        Read only field indicating whether homekit is already paired, currently open for pairing, or unpaired. Transitions: – unpaired > pairing – pushlink button press or power cycle – pairing > paired – through HAP – pairing > unpaired – 10 minutes – paired > unpaired – homekit reset.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/matter

API to manage matter service

#### [/resource/matter](#panel_resource_matter) [get](#resource_matter_get)

get

×

#### get /resource/matter

*   [Response](#resource_matter_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MatterGet)_
    
    **Items**: MatterGet
    
    *   **type**: _(matter)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **max\_fabrics**: _required(integer)_
        
        Maximum number of fabrics that can exist at a time
        
    *   **has\_qr\_code**: _required(boolean)_
        
        Indicates whether a physical QR code is present
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/matter/{id}](#panel_resource_matter__id_) [put](#resource_matter__id__put) [get](#resource_matter__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/matter/{id}

*   [Request](#resource_matter__id__put_request)
*   [Response](#resource_matter__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(matter)_
    
    Type of the supported resources
    
*   **action**: _required(matter\_reset)_
    
    matter\_reset: Resets Matter, including removing all fabrics and reset state to factory settings
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/matter/{id}

*   [Request](#resource_matter__id__get_request)
*   [Response](#resource_matter__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MatterGet)_
    
    **Items**: MatterGet
    
    *   **type**: _(matter)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **max\_fabrics**: _required(integer)_
        
        Maximum number of fabrics that can exist at a time
        
    *   **has\_qr\_code**: _required(boolean)_
        
        Indicates whether a physical QR code is present
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/matter\_fabric

API to manage matter fabrics

#### [/resource/matter\_fabric](#panel_resource_matter_fabric) [get](#resource_matter_fabric_get)

get

×

#### get /resource/matter\_fabric

*   [Response](#resource_matter_fabric_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MatterFabricGet)_
    
    **Items**: MatterFabricGet
    
    *   **type**: _(matter\_fabric)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **status**: _required(one of pending, timedout, paired)_
        
        only a fabric with status paired has label and vendor\_id properties
        
    *   **fabric\_data**: _(object)_
        
        Human readable context to identify fabric
        
        *   **label**: _required(string – minLength: 1)_
            
            Human readable context to identify fabric
            
        *   **vendor\_id**: _required(integer)_
            
            Matter vendor id of entity that created the fabric association
            
    *   **creation\_time**: _required(datetime)_
        
        UTC date and time when the fabric association was created
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/matter\_fabric/{id}](#panel_resource_matter_fabric__id_) [delete](#resource_matter_fabric__id__delete) [get](#resource_matter_fabric__id__get)

API calls to read, update and delete a resource instance

delete

get

×

#### delete /resource/matter\_fabric/{id}

*   [Request](#resource_matter_fabric__id__delete_request)
*   [Response](#resource_matter_fabric__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/matter\_fabric/{id}

*   [Request](#resource_matter_fabric__id__get_request)
*   [Response](#resource_matter_fabric__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of MatterFabricGet)_
    
    **Items**: MatterFabricGet
    
    *   **type**: _(matter\_fabric)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **status**: _required(one of pending, timedout, paired)_
        
        only a fabric with status paired has label and vendor\_id properties
        
    *   **fabric\_data**: _(object)_
        
        Human readable context to identify fabric
        
        *   **label**: _required(string – minLength: 1)_
            
            Human readable context to identify fabric
            
        *   **vendor\_id**: _required(integer)_
            
            Matter vendor id of entity that created the fabric association
            
    *   **creation\_time**: _required(datetime)_
        
        UTC date and time when the fabric association was created
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource

API to retrieve all API resources

#### [/resource](#panel_resource) [get](#resource_get)

get

×

#### get /resource

*   [Response](#resource_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceGet)_
    
    **Items**: ResourceGet
    
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **type**: _(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        Type of the supported resources
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/smart\_scene

API to manage smart scenes

#### [/resource/smart\_scene](#panel_resource_smart_scene) [post](#resource_smart_scene_post) [get](#resource_smart_scene_get)

post

get

×

#### post /resource/smart\_scene

*   [Request](#resource_smart_scene_post_request)
*   [Response](#resource_smart_scene_post_response)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(smart\_scene)_
    
    Type of the supported resources
    
*   **metadata**: _required(object)_
    *   **name**: _required(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **image**: _(object)_
        
        Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
        
        Application specific data. Free format string.
        
*   **group**: _required(object)_
    
    Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
*   **week\_timeslots**: _required(array of DayTimeslotsPost)_
    
    information on what is the light state for every timeslot of the day
    
    **Items**: DayTimeslotsPost
    
    *   **timeslots**: _required(array of SmartSceneTimeslotPost)_
        
        **Items**: SmartSceneTimeslotPost
        
        *   **start\_time**: _required(object)_
            *   **kind**: _required(one of time, sunset)_
            *   **time**: _(object)_
                
                this property is only used when property “kind” is “time”
                
                *   **hour**: _required(integer – minimum: 0 – maximum: 23)_
                *   **minute**: _required(integer – minimum: 0 – maximum: 59)_
                *   **second**: _required(integer – minimum: 0 – maximum: 59)_
        *   **target**: _required(object)_
            
            The identifier of the scene to recall
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        
    *   **recurrence**: _required(array of WeekDay)_
    
*   **transition\_duration**: _(integer)_
    
    duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)
    
*   **recall**: _(object)_
    *   **action**: _required(one of activate, deactivate)_
        
        Activate will start the smart (24h) scene; deactivate will stop it
        

## HTTP status code [201](http://httpstatus.es/201)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/smart\_scene

*   [Response](#resource_smart_scene_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of SmartSceneGet)_
    
    **Items**: SmartSceneGet
    
    *   **type**: _(smart\_scene)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **image**: _(object)_
            
            Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
            
            Application specific data. Free format string.
            
    *   **group**: _required(object)_
        
        Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **week\_timeslots**: _required(array of DayTimeslotsGet)_
        
        information on what is the light state for every timeslot of the day
        
        **Items**: DayTimeslotsGet
        
        *   **timeslots**: _required(array of SmartSceneTimeslotGet)_
            
            **Items**: SmartSceneTimeslotGet
            
            *   **start\_time**: _required(object)_
                *   **kind**: _required(one of time, sunset)_
                *   **time**: _required(object)_
                    
                    this property is only used when property “kind” is “time”
                    
                    *   **hour**: _required(integer – minimum: 0 – maximum: 23)_
                    *   **minute**: _required(integer – minimum: 0 – maximum: 59)_
                    *   **second**: _required(integer – minimum: 0 – maximum: 59)_
            *   **target**: _required(object)_
                
                The identifier of the scene to recall
                
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            
        *   **recurrence**: _required(array of WeekDay)_
        
    *   **transition\_duration**: _required(integer)_
        
        duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)
        
    *   **active\_timeslot**: _(object)_
        
        the active time slot in execution
        
        *   **timeslot\_id**: _required(integer)_
        *   **weekday**: _required(one of monday, tuesday, wednesday, thursday, friday, saturday, sunday)_
    *   **state**: _required(one of active, inactive)_
        
        the current state of the smart scene. The default state is `inactive` if no `recall` is provided
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/smart\_scene/{id}](#panel_resource_smart_scene__id_) [delete](#resource_smart_scene__id__delete) [put](#resource_smart_scene__id__put) [get](#resource_smart_scene__id__get)

API calls to read, update and delete a resource instance

delete

put

get

×

#### delete /resource/smart\_scene/{id}

*   [Request](#resource_smart_scene__id__delete_request)
*   [Response](#resource_smart_scene__id__delete_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### put /resource/smart\_scene/{id}

*   [Request](#resource_smart_scene__id__put_request)
*   [Response](#resource_smart_scene__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(smart\_scene)_
    
    Type of the supported resources
    
*   **metadata**: _(object)_
    *   **name**: _(string – minLength: 1 – maxLength: 32)_
        
        Human readable name of a resource
        
    *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
        
        Application specific data. Free format string.
        
*   **week\_timeslots**: _(array of DayTimeslotsPut)_
    
    information on what is the light state for every timeslot of the day
    
    **Items**: DayTimeslotsPut
    
    *   **timeslots**: _required(array of SmartSceneTimeslotPut)_
        
        **Items**: SmartSceneTimeslotPut
        
        *   **start\_time**: _required(object)_
            *   **kind**: _required(one of time, sunset)_
            *   **time**: _(object)_
                
                this property is only used when property “kind” is “time”
                
                *   **hour**: _required(integer – minimum: 0 – maximum: 23)_
                *   **minute**: _required(integer – minimum: 0 – maximum: 59)_
                *   **second**: _(integer – minimum: 0 – maximum: 59)_
        *   **target**: _required(object)_
            
            The identifier of the scene to recall
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        
    *   **recurrence**: _required(array of WeekDay)_
    
*   **transition\_duration**: _(integer)_
    
    duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)
    
*   **recall**: _(object)_
    *   **action**: _(one of activate, deactivate)_
        
        Activate will start the smart (24h) scene; deactivate will stop it
        

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/smart\_scene/{id}

*   [Request](#resource_smart_scene__id__get_request)
*   [Response](#resource_smart_scene__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of SmartSceneGet)_
    
    **Items**: SmartSceneGet
    
    *   **type**: _(smart\_scene)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **metadata**: _required(object)_
        *   **name**: _required(string – minLength: 1 – maxLength: 32)_
            
            Human readable name of a resource
            
        *   **image**: _(object)_
            
            Reference with unique identifier for the image representing the scene only accepting “rtype”: “public\_image” on creation
            
            *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                
                The unique id of the referenced resource
                
            *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                
                The type of the referenced resource
                
        *   **appdata**: _(string – minLength: 1 – maxLength: 16)_
            
            Application specific data. Free format string.
            
    *   **group**: _required(object)_
        
        Group associated with this Scene. All services in the group are part of this scene. If the group is changed the scene is update (e.g. light added/removed)
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **week\_timeslots**: _required(array of DayTimeslotsGet)_
        
        information on what is the light state for every timeslot of the day
        
        **Items**: DayTimeslotsGet
        
        *   **timeslots**: _required(array of SmartSceneTimeslotGet)_
            
            **Items**: SmartSceneTimeslotGet
            
            *   **start\_time**: _required(object)_
                *   **kind**: _required(one of time, sunset)_
                *   **time**: _required(object)_
                    
                    this property is only used when property “kind” is “time”
                    
                    *   **hour**: _required(integer – minimum: 0 – maximum: 23)_
                    *   **minute**: _required(integer – minimum: 0 – maximum: 59)_
                    *   **second**: _required(integer – minimum: 0 – maximum: 59)_
            *   **target**: _required(object)_
                
                The identifier of the scene to recall
                
                *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
                    
                    The unique id of the referenced resource
                    
                *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
                    
                    The type of the referenced resource
                    
            
        *   **recurrence**: _required(array of WeekDay)_
        
    *   **transition\_duration**: _required(integer)_
        
        duration of the transition from on one timeslot's scene to the other (defaults to 60000ms)
        
    *   **active\_timeslot**: _(object)_
        
        the active time slot in execution
        
        *   **timeslot\_id**: _required(integer)_
        *   **weekday**: _required(one of monday, tuesday, wednesday, thursday, friday, saturday, sunday)_
    *   **state**: _required(one of active, inactive)_
        
        the current state of the smart scene. The default state is `inactive` if no `recall` is provided
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/contact

API to manage contact sensor state for general purpose cases. These are offered by devices that have a static “switch” position. Not necessarily a physical switch.

#### [/resource/contact](#panel_resource_contact) [get](#resource_contact_get)

get

×

#### get /resource/contact

*   [Response](#resource_contact_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ContactGet)_
    
    **Items**: ContactGet
    
    *   **type**: _(contact)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **contact\_report**: _(object)_
        *   **changed**: _required(datetime)_
            
            last time the value of this property is changed.
            
        *   **state**: _required(one of contact, no\_contact)_
            
            contact and no\_contact are the states of the sensor after last state-change.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/contact/{id}](#panel_resource_contact__id_) [put](#resource_contact__id__put) [get](#resource_contact__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/contact/{id}

*   [Request](#resource_contact__id__put_request)
*   [Response](#resource_contact__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(contact)_
    
    Type of the supported resources
    
*   **enabled**: _(boolean)_
    
    true when sensor is activated, false when deactivated
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/contact/{id}

*   [Request](#resource_contact__id__get_request)
*   [Response](#resource_contact__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ContactGet)_
    
    **Items**: ContactGet
    
    *   **type**: _(contact)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **enabled**: _required(boolean)_
        
        true when sensor is activated, false when deactivated
        
    *   **contact\_report**: _(object)_
        *   **changed**: _required(datetime)_
            
            last time the value of this property is changed.
            
        *   **state**: _required(one of contact, no\_contact)_
            
            contact and no\_contact are the states of the sensor after last state-change.
            
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

### /resource/tamper

API to manage device tamper state. Offered by devices capable of detecting tampering.

#### [/resource/tamper](#panel_resource_tamper) [get](#resource_tamper_get)

get

×

#### get /resource/tamper

*   [Response](#resource_tamper_get_response)

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of TamperGet)_
    
    **Items**: TamperGet
    
    *   **type**: _(tamper)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **tamper\_reports**: _required(array of TamperReport)_
        
        **Items**: TamperReport
        
        *   **changed**: _required(datetime)_
            
            last time the value of this property is changed.
            
        *   **source**: _required(battery\_door)_
            
            Source of tamper and time expired since last change of tamper-state.
            
        *   **state**: _required(one of tampered, not\_tampered)_
            
            tampered and not\_tampered are the state of tamper after last change of tamper\_state.
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [406](http://httpstatus.es/406)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

#### [/resource/tamper/{id}](#panel_resource_tamper__id_) [put](#resource_tamper__id__put) [get](#resource_tamper__id__get)

API calls for resource which cannot be deleted (PUT and GET on resource instance)

put

get

×

#### put /resource/tamper/{id}

*   [Request](#resource_tamper__id__put_request)
*   [Response](#resource_tamper__id__put_response)

### URI Parameters

*   **id**: _required(string)_

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **type**: _(tamper)_
    
    Type of the supported resources
    

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [207](http://httpstatus.es/207)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of ResourceIdentifier)_
    
    **Items**: ResourceIdentifier
    
    *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        The unique id of the referenced resource
        
    *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
        
        The type of the referenced resource
        
    

## HTTP status code [400](http://httpstatus.es/400)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [507](http://httpstatus.es/507)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

×

#### get /resource/tamper/{id}

*   [Request](#resource_tamper__id__get_request)
*   [Response](#resource_tamper__id__get_response)

### URI Parameters

*   **id**: _required(string)_

## HTTP status code [200](http://httpstatus.es/200)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    
*   **data**: _required(array of TamperGet)_
    
    **Items**: TamperGet
    
    *   **type**: _(tamper)_
        
        Type of the supported resources
        
    *   **id**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
        
        Unique identifier representing a specific resource instance
        
    *   **id\_v1**: _(string – pattern: ^(\\/\[a-z\]{4,32}\\/\[0-9a-zA-Z-\]{1,32})?$)_
        
        Clip v1 resource identifier
        
    *   **owner**: _required(object)_
        
        Owner of the service, in case the owner service is deleted, the service also gets deleted
        
        *   **rid**: _required(string – pattern: ^\[0-9a-f\]{8}-(\[0-9a-f\]{4}-){3}\[0-9a-f\]{12}$)_
            
            The unique id of the referenced resource
            
        *   **rtype**: _required(one of device, bridge\_home, room, zone, service\_group, light, button, relative\_rotary, temperature, light\_level, motion, camera\_motion, entertainment, contact, tamper, grouped\_light, grouped\_motion, grouped\_light\_level, device\_power, device\_software\_update, zigbee\_bridge\_connectivity, zigbee\_connectivity, zgp\_connectivity, remote\_access, bridge, zigbee\_device\_discovery, system\_update, homekit, matter, matter\_fabric, scene, entertainment\_configuration, public\_image, auth\_v1, behavior\_script, behavior\_instance, geofence, geofence\_client, geolocation, smart\_scene)_
            
            The type of the referenced resource
            
    *   **tamper\_reports**: _required(array of TamperReport)_
        
        **Items**: TamperReport
        
        *   **changed**: _required(datetime)_
            
            last time the value of this property is changed.
            
        *   **source**: _required(battery\_door)_
            
            Source of tamper and time expired since last change of tamper-state.
            
        *   **state**: _required(one of tampered, not\_tampered)_
            
            tampered and not\_tampered are the state of tamper after last change of tamper\_state.
            
        
    

## HTTP status code [401](http://httpstatus.es/401)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [403](http://httpstatus.es/403)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [404](http://httpstatus.es/404)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [405](http://httpstatus.es/405)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [409](http://httpstatus.es/409)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [429](http://httpstatus.es/429)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [500](http://httpstatus.es/500)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    *   **description**: _required(string)_
        
        a human-readable explanation specific to this occurrence of the problem.
        
    

## HTTP status code [503](http://httpstatus.es/503)

### Body

**Media type**: application/json

**Type**: object

**Properties**

*   **errors**: _required(array of Error)_
    
    **Items**: Error
    
    

core-concepts.md

hue-bridge-discovery.md