Harbor Gateway
  1. Health & Status
Harbor Gateway
  • Harbor Gateway API
    • Health & Status
      • Admin interface
        GET
      • Health check
        GET
    • Transactions
      • List all transactions
      • Create a transaction
      • Get transaction details
      • Release transaction
      • Open locker by transaction ID
    • Lockers
      • List all lockers
      • Get locker details
      • Open locker by ID
      • Open all lockers
    • 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. Health & Status

Health check

GET
/health
Quick health check endpoint to verify the service is running

Request

None

Responses

🟢200OK
application/json
Service is healthy
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/health'
Response Response Example
{
    "status": "ok",
    "timestamp": "2019-08-24T14:15:22Z"
}
Modified at 2025-11-27 00:04:50
Previous
Admin interface
Next
List all transactions
Built with