Creating a REST Device

After creating a device 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.

Configuration Fields

REST Type

The type of REST service you're connecting to.

• Required

URL

The base URL of the BOSS server: scheme and host only, with no path. Koios appends the BOSS service path itself, so a URL that already contains a path produces an address the controller cannot serve.

• Required
• Example: https://192.168.1.100

Authentication Type

How Koios authenticates with the REST API.

• Default: Username/Password (the Add Device form pre-selects No Authentication, so set it there if the API needs credentials)

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). The Add Device form pre-fills it as enabled.

Timeout (seconds)

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

• Default: 5 seconds (the Add Device form pre-fills 30)
• 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 (the Add Device form pre-fills 3)
• 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)
4. Enable the device: flip the enable switch to start scanning