List all lock controllers

GET

/controllers

Retrieve all lock controllers in the system, including their operational status,
assigned locker count, and network information.

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

List of all controllers

Body

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

[
    {
        "id": 0,
        "name": "string",
        "hostname": "string",
        "ipAddress": "string",
        "port": 8080,
        "operational": true,
        "operationalLastChecked": "2019-08-24T14:15:22Z",
        "lastSeen": "2019-08-24T14:15:22Z",
        "reasonCode": "CONTROL_BOARD_UNREACHABLE",
        "reason": "string",
        "lockerCount": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
    }
]

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

Logout and invalidate session token

Manually add a lock controller