Trigger manual mDNS scan

POST

/controllers/scan

Manually trigger an mDNS scan to discover new lock controllers on the network.

The service automatically scans for controllers periodically via mDNS, but this
endpoint allows administrators to force an immediate scan when adding new hardware.

Use cases:

After physically connecting a new controller to the network

When troubleshooting controller connectivity issues

After network configuration changes

Behavior:

Scans for _luxer-lockers._tcp mDNS services

Automatically provisions 20 lockers for any newly discovered controllers

Returns count of newly discovered controllers (does not re-add existing ones)

Non-blocking operation completes within a few seconds

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

API Key

Add parameter in header

X-Session-Token

Example:

X-Session-Token: ********************

Responses

🟢200OK

application/json

Scan completed successfully

Body

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/controllers/scan' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - Example 1

{
    "success": true,
    "foundControllers": 0,
    "newControllers": 0,
    "controllers": [
        {
            "id": 0,
            "name": "string",
            "hostname": "string",
            "ip_address": "string",
            "port": 0
        }
    ]
}

Modified at 2025-11-27 00:06:25

Manually add a lock controller

Get controller details