Adjust locker count for controller

PATCH

/controllers/{controllerId}/lockers

Add or remove lockers for a controller. When reducing count, checks for active transactions
and returns error if any lockers above the new count have active transactions.

Behavior:

Increasing count: Adds new lockers sequentially (ports current_count+1 to new_count)

Decreasing count: Deletes lockers above new_count, but only if they have no active transactions

Same count: Returns success with no changes

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

Locker count adjusted successfully

Body

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/controllers//lockers' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "lockerCount": 1
}'

Response Example

200 - Example 1

{
    "success": true,
    "previousCount": 0,
    "newCount": 0
}

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

Replace a failed controller

Update locker service state