1. Lockers
Harbor Gateway
  • Harbor Gateway Local API
    • How to Use Harbor Gateway Local API
    • Health & Status
      • Admin interface
      • Health check
    • Transactions
      • List all transactions
      • Create a transaction
      • Get transaction details
      • Release transaction
      • Open locker by transaction ID
    • Lockers
      • List all lockers
        GET
      • Get locker configuration
        GET
      • Get locker details
        GET
      • Update locker service state
        PATCH
      • Open locker by ID
        POST
      • Open all lockers
        POST
    • Locker Types
      • List all locker types
      • Get locker type details
    • Bank Types
      • List all bank types
      • Get bank type with associations
    • System
      • Receive heartbeat from external device
    • Schemas
      • Locker
      • LockerTypeSummary
      • TransactionResponse
      • LockerType
      • LockController
      • LockerConfig
      • System
      • LogEntry
      • OperationResponse
      • LockerOperationResponse
      • MultiStatusOperationResponse
      • BankType
      • OpenAllLockersResponse
      • BankTypeAssociation
      • Error
      • BankTypeWithAssociations
      • DeviceHeartbeatRequest
  • Harbor Gateway Cloud API
    • How to Use Harbor Gateway Cloud API
    • Meta
      • API version probe
    • Session
      • Identify the authenticated API key
      • List locations accessible to this API key
    • Requests
      • Poll a pending request
    • Locations
      • Gateway health check
    • System
      • Gateway system info
    • Transactions
      • List transactions at a location
      • Create a transaction
      • Fetch a transaction
      • Release a transaction
      • Open the locker assigned to a transaction
    • Lockers
      • List lockers
      • Locker configuration
      • Fetch a locker
      • Update a locker (e.g. out-of-service)
      • Open a specific locker
    • Types
      • List locker types
      • Fetch a locker type
      • List bank types
      • Fetch a bank type
    • Schemas
      • ApiMeta
      • MeResponse
      • LocationSummary
      • LocationList
      • PendingRequest
      • Error
      • CreateTransactionBody
      • PatchLockerBody
  1. Lockers

Get locker configuration

GET
harbor-gateway.local/lockers/config
Retrieve static configuration for all lockers without state information.
Returns only the physical configuration (locker IDs, controller assignments, ports, types)
without dynamic state like availability, operational status, transactions, or door state.
Use this endpoint to understand the physical locker layout and assignments.

Request

None

Responses

🟢200
application/json
Locker configuration list
Bodyapplication/json

🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'harbor-gateway.local/lockers/config'
Response Response Example
200 - Example 1
[
    {
        "lockerId": 0,
        "lockControllerId": 0,
        "controllerName": "string",
        "controllerHostname": "string",
        "lockPort": 0,
        "bankId": 0,
        "bankName": "string",
        "bankLockerNumber": 0,
        "lockerTypeId": 0,
        "lockerTypeSlug": "string",
        "isLow": true
    }
]
Modified at 2026-02-20 22:56:40
Previous
List all lockers
Next
Get locker details
Built with