Update controller settings

PATCH

/controllers/{controllerId}

Update controller configuration properties including name, network settings, and operational status.

Updatable fields:

name: Human-readable controller name

ipAddress: IP address for direct access (useful when mDNS unreliable)

port: HTTP port for control board API

operational: Manual override of operational status

reasonCode/reason: Explanation when setting operational to false

All fields are optional. Only provided fields will be updated.

Note: To adjust locker count, use PATCH /controllers/{controllerId}/lockers endpoint instead.

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: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Controller updated successfully

Body

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/controllers/' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "South Bank",
    "ipAddress": "192.168.1.100",
    "port": 8080,
    "operational": true,
    "reasonCode": "string",
    "reason": "string"
}'

Response Example

200 - Example 1

{
    "success": true
}

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

Get controller details

Remove controller from system