# Harbor Gateway ## API Docs - Root > Health & Status [Admin interface](https://dsade5tqi0.apidog.io/admin-interface-24822994e0.md): Serves the admin interface HTML frontend. This is the primary web interface for managing the locker service. - Root > Health & Status [Health check](https://dsade5tqi0.apidog.io/health-check-24822995e0.md): Quick health check endpoint to verify the service is running - Root > Transactions [List all transactions](https://dsade5tqi0.apidog.io/list-all-transactions-24822996e0.md): Retrieve all active transactions in the system - Root > Transactions [Create a transaction](https://dsade5tqi0.apidog.io/create-a-transaction-24822997e0.md): Finds and assigns an available locker for the provided transactionId. Does not open the locker door - use the open endpoint separately when ready. - Root > Transactions [Get transaction details](https://dsade5tqi0.apidog.io/get-transaction-details-24822998e0.md): Retrieve information about a specific transaction and its associated locker - Root > Transactions [Release transaction](https://dsade5tqi0.apidog.io/release-transaction-24822999e0.md): Releases the transaction, disassociating it from the locker and marking the locker as available. Does not trigger any door operations. - Root > Transactions [Open locker by transaction ID](https://dsade5tqi0.apidog.io/open-locker-by-transaction-id-24823000e0.md): Opens the locker associated with the transaction without disassociating it. 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. Does not check outOfService or operational status (optimistic opening - useful for troubleshooting/maintenance). - Root > Lockers [List all lockers](https://dsade5tqi0.apidog.io/list-all-lockers-24823001e0.md): Retrieve the status of all lockers in the system with optional filters - Root > Lockers [Get locker details](https://dsade5tqi0.apidog.io/get-locker-details-24823002e0.md): Retrieve information about a specific locker - Root > Lockers [Open locker by ID](https://dsade5tqi0.apidog.io/open-locker-by-id-24823003e0.md): 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). - Root > Lockers [Open all lockers](https://dsade5tqi0.apidog.io/open-all-lockers-24823004e0.md): Opens all lockers in the system. Each locker operation uses 20-second timeout per attempt, up to 3 attempts with 1-second delays between retries (maximum total time ~62 seconds per locker). Retries occur on network/communication errors only; hardware malfunctions are not retried. For maintenance/emergency use - does not check outOfService or operational status (optimistic opening). - Root > System [Get system information](https://dsade5tqi0.apidog.io/get-system-information-24823005e0.md): Retrieve system status, configuration, and controller information - Root > System [Update system configuration](https://dsade5tqi0.apidog.io/update-system-configuration-24823006e0.md): Update system configuration settings such as location identifier. - Root > System [Get system logs](https://dsade5tqi0.apidog.io/get-system-logs-24823007e0.md): Retrieve system logs with optional filtering - Root > Authentication [Login with Basic Auth and receive session token](https://dsade5tqi0.apidog.io/login-with-basic-auth-and-receive-session-token-24823021e0.md): Authenticate with HTTP Basic Auth and receive a session token for subsequent requests. - Root > Authentication [Logout and invalidate session token](https://dsade5tqi0.apidog.io/logout-and-invalidate-session-token-24823022e0.md): Invalidate the current session token, forcing re-authentication for future requests. - Root > Controllers [List all lock controllers](https://dsade5tqi0.apidog.io/list-all-lock-controllers-24823023e0.md): Retrieve all lock controllers in the system, including their operational status, - Root > Controllers [Manually add a lock controller](https://dsade5tqi0.apidog.io/manually-add-a-lock-controller-24823024e0.md): Manually register a lock controller when mDNS auto-discovery is unavailable or fails. - Root > Controllers [Trigger manual mDNS scan](https://dsade5tqi0.apidog.io/trigger-manual-mdns-scan-24823025e0.md): Manually trigger an mDNS scan to discover new lock controllers on the network. - Root > Controllers [Get controller details](https://dsade5tqi0.apidog.io/get-controller-details-24823026e0.md): Retrieve detailed information about a specific lock controller - Root > Controllers [Update controller settings](https://dsade5tqi0.apidog.io/update-controller-settings-24823027e0.md): Update controller configuration properties including name, network settings, and operational status. - Root > Controllers [Remove controller from system](https://dsade5tqi0.apidog.io/remove-controller-from-system-24823028e0.md): Delete a lock controller and all its lockers from the system. - Root > Controllers [Replace a failed controller](https://dsade5tqi0.apidog.io/replace-a-failed-controller-24823029e0.md): Replace a failed or offline controller with a newly discovered one. The physical - Root > Controllers [Adjust locker count for controller](https://dsade5tqi0.apidog.io/adjust-locker-count-for-controller-24823030e0.md): Add or remove lockers for a controller. When reducing count, checks for active transactions - Root > Lockers [Update locker service state](https://dsade5tqi0.apidog.io/update-locker-service-state-24823031e0.md): Update a locker's service state (enable/disable for maintenance). - Root > System [Refresh network information](https://dsade5tqi0.apidog.io/refresh-network-information-24823032e0.md): Manually refresh system network information including IP address, gateway, and MAC address. - Root > System [Reboot gateway system](https://dsade5tqi0.apidog.io/reboot-gateway-system-24823033e0.md): Schedule a system reboot with optional delay. WARNING: This will reboot the Raspberry Pi - Root > Diagnostics [Test Sentry error tracking integration](https://dsade5tqi0.apidog.io/test-sentry-error-tracking-integration-24823034e0.md): Debug endpoint that intentionally triggers an error to verify Sentry integration. ## Schemas - Root [Locker](https://dsade5tqi0.apidog.io/locker-11234081d0.md): - Root [TransactionResponse](https://dsade5tqi0.apidog.io/transactionresponse-11234082d0.md): - Root [LockController](https://dsade5tqi0.apidog.io/lockcontroller-11234083d0.md): - Root [System](https://dsade5tqi0.apidog.io/system-11234084d0.md): - Root [LogEntry](https://dsade5tqi0.apidog.io/logentry-11234085d0.md): - Root [OperationResponse](https://dsade5tqi0.apidog.io/operationresponse-11234086d0.md): - Root [LockerOperationResponse](https://dsade5tqi0.apidog.io/lockeroperationresponse-11234087d0.md): - Root [MultiStatusOperationResponse](https://dsade5tqi0.apidog.io/multistatusoperationresponse-11234088d0.md): - Root [OpenAllLockersResponse](https://dsade5tqi0.apidog.io/openalllockersresponse-11234089d0.md): - Root [Error](https://dsade5tqi0.apidog.io/error-11234090d0.md): - Root > Schemas [Controller](https://dsade5tqi0.apidog.io/controller-11234092d0.md): - Root > Schemas [ControllerDetails](https://dsade5tqi0.apidog.io/controllerdetails-11234093d0.md): - Root > Schemas [CreateControllerRequest](https://dsade5tqi0.apidog.io/createcontrollerrequest-11234094d0.md): - Root > Schemas [AdjustLockerCountResponse](https://dsade5tqi0.apidog.io/adjustlockercountresponse-11234095d0.md): - Root > Schemas [OperationResponse](https://dsade5tqi0.apidog.io/operationresponse-11234096d0.md): - Root > Schemas [Error](https://dsade5tqi0.apidog.io/error-11234097d0.md): - Root > Response [Unauthorized](https://dsade5tqi0.apidog.io/unauthorized-11234098d0.md): - Root > Response [NotFound](https://dsade5tqi0.apidog.io/notfound-11234099d0.md): - Root > Response [InternalServerError](https://dsade5tqi0.apidog.io/internalservererror-11234100d0.md):