1. Health & Status
Harbor Gateway
  • Harbor Gateway Local API
    • How to Use Harbor Gateway Local 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 configuration
      • Get locker details
      • Update locker service state
      • Open locker by ID
      • Open all lockers
    • 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. Health & Status

Health check

GET
harbor-gateway.local/health
Quick health check endpoint to verify the service is running

Request

None

Responses

🟢200
application/json
Service is healthy
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'harbor-gateway.local/health'
Response Response Example
{
    "status": "ok",
    "timestamp": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-02-20 22:56:40
Previous
Admin interface
Next
List all transactions
Built with