Harbor Gateway
  1. Lockers
Harbor Gateway
  • Harbor Gateway 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 details
        GET
      • Open locker by ID
        POST
      • Open all lockers
        POST
    • System
      • Get system information
      • Update system configuration
      • Get system logs
    • Schemas
      • Locker
      • TransactionResponse
      • LockController
      • System
      • LogEntry
      • OperationResponse
      • LockerOperationResponse
      • MultiStatusOperationResponse
      • OpenAllLockersResponse
      • Error
  • Harbor Gateway Admin API
    • Authentication
      • Login with Basic Auth and receive session token
      • Logout and invalidate session token
    • Controllers
      • List all lock controllers
      • Manually add a lock controller
      • Trigger manual mDNS scan
      • Get controller details
      • Update controller settings
      • Remove controller from system
      • Replace a failed controller
      • Adjust locker count for controller
    • Lockers
      • Update locker service state
    • System
      • Refresh network information
      • Reboot gateway system
    • Diagnostics
      • Test Sentry error tracking integration
    • Schemas
      • Schemas
        • Controller
        • ControllerDetails
        • CreateControllerRequest
        • AdjustLockerCountResponse
        • OperationResponse
        • Error
      • Response
        • Unauthorized
        • NotFound
        • InternalServerError
  1. Lockers

Open locker by ID

POST
/lockers/{lockerId}/open
Opens a specific locker by its ID. Physical operation with 20-second timeout per attempt, up to 3 attempts with 1-second delays (maximum total time ~62 seconds). Retries occur on network/communication errors only; hardware malfunctions are not retried. For maintenance use - does not check transaction status, outOfService, or operational status (optimistic opening - useful for troubleshooting/maintenance).

Request

Path Params

Responses

🟢200OK
application/json
Locker opened successfully
Body

🟠404Not Found
🔴500Internal Server Error
🔴503Service Unavailable
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/lockers//open'
Response Response Example
200 - Example 1
{
    "success": true,
    "lockerId": 0,
    "doorOpen": true,
    "message": "string"
}
Modified at 2025-11-27 00:04:50
Previous
Get locker details
Next
Open all lockers
Built with