---
title: "Creating a REST Device"
description: "Configure a connection to a REST API device"
source_url: https://ai-ops.com/docs/devices/creating-rest
---

# Creating a REST Device

After [creating a device](https://ai-ops.com/docs/devices/creating-getting-started.md) with the **REST** protocol, you'll land on its **Configuration** tab. This is where you provide the connection details Koios needs to communicate with the REST API.

> [!NOTE] Built for CAREL BOSS
> The REST protocol in Koios is designed for connecting to **CAREL BOSS** (Building Operation System Server) devices. BOSS exposes a REST API for reading and writing HVAC variables such as alarms, analog values, digital states, and integer registers.

## Configuration Fields

### REST Type

The type of REST service you're connecting to.

| Type | Description |
|------|-------------|
| **Boss** | CAREL BOSS building management system |

- **Required**

### URL

The base URL of the REST API endpoint.

- **Required**
- Example: `https://192.168.1.100/api/v1`

### Authentication Type

How Koios authenticates with the REST API.

| Type | Description |
|------|-------------|
| **None** | No authentication required |
| **Username/Password** | Authenticate with credentials |

- **Default:** Username/Password

When set to **Username/Password**, two additional fields appear:

- **Username** — the account to authenticate as *(required)*
- **Password** — the password for the account *(required)*

### Verify SSL

Whether Koios verifies the server's SSL certificate when connecting over HTTPS.

- **Default:** Disabled (unchecked)

> [!WARNING] Disabling SSL verification
> Only disable SSL verification for devices using self-signed certificates on trusted networks. Disabling it on untrusted networks exposes the connection to man-in-the-middle attacks.

### Timeout (seconds)

How long Koios waits for the API to respond before giving up.

- **Default:** 5 seconds
- **Minimum:** 1 second
- **Maximum:** 300 seconds (5 minutes)

### Max Retries

The maximum number of times Koios will retry a failed request before reporting an error.

- **Default:** 5
- **Minimum:** 1
- **Maximum:** 10

## After Configuration

Once you've filled in the connection settings:

1. **Save** the configuration
2. **Test the connection** — click the `Test` button to verify Koios can reach the BOSS API
3. **Add tags** — define the BOSS variables you want to read or write (see [Creating a REST Tag](https://ai-ops.com/docs/tags/creating-rest.md))
4. **Enable the device** — flip the enable switch to start scanning