Harbor Gateway
  1. System
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 locker details
      • Open locker by ID
      • Open all lockers
    • System
      • Get system information
        GET
      • Update system configuration
        PATCH
      • Get system logs
        GET
    • 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. System

Get system information

GET
/system
Retrieve system status, configuration, and controller information

Request

None

Responses

🟢200OK
application/json
System information
Body

🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/system'
Response Response Example
200 - Example 1
{
    "serialNumber": "string",
    "hostname": "string",
    "locationId": "string",
    "version": "string",
    "schemaVersion": 0,
    "ipAddress": "string",
    "gateway": "string",
    "macAddress": "string",
    "controllers": [
        {
            "id": 0,
            "name": "string",
            "hostname": "string",
            "ipAddress": "string",
            "operational": true,
            "lastSeen": "2019-08-24T14:15:22Z",
            "lockerCount": 0
        }
    ],
    "networkLastUpdated": "2019-08-24T14:15:22Z"
}
Modified at 2025-11-27 00:04:50
Previous
Open all lockers
Next
Update system configuration
Built with