REST API  17
REST API for Luna Network HSMs
GET /api/lunasa/hsms/{hsmid}

GET /api/lunasa/hsms/{hsmid}

Gets the information associated with a specific HSM.

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1
   maximum: 9999999999

Responses

200

HSM details

JSON Schema: HSM

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

404

HSM does not exist.

Example Request

   GET
   https://1.2.3.4:8443/api/lunasa/hsms/154704

Example Result

{
    "actions": "/api/lunasa/hsms/123456/actions",
    "auditInitialized": false,
    "authenticationMethod": "password",
    "bootloader": "1.1.5",
    "capabilities": "/api/lunasa/hsms/123456/capabilities",
    "certificate": "/api/lunasa/hsms/123456/certificate",
    "counter": "/api/lunasa/hsms/123456/counter",
    "fipsModeEnabled": false,
    "firmware": "/api/lunasa/hsms/123456/firmware",
    "firmwareVersion": "7.9.0",
    "indirect": "/api/lunasa/hsms/123456/indirect",
    "indirectLoginEnabled": false,
    "isTransportMode": false,
    "label": "myhsm",
    "licenses": "/api/lunasa/hsms/123456/licenses",
    "loggedIn": "nobody",
    "manuallyZeroized": false,
    "metrics": "/api/lunasa/hsms/123456/metrics",
    "model": "K7 Base",
    "partNumber": "808-000073-001",
    "partitions": "/api/lunasa/hsms/123456/partitions",
    "partitionsAllowed": 10,
    "partitionsCreated": 0,
    "ped": "/api/lunasa/hsms/123456/ped",
    "pedPresent": false,
    "policies": "/api/lunasa/hsms/123456/policies",
    "remoteLoginInitialized": false,
    "roles": "/api/lunasa/hsms/123456/roles",
    "rpvInitialized": false,
    "soChangePasswordAttemptsLeft": 3,
    "soLoginsLeft": 3,
    "state": "initialized",
    "storageSpace": {
        "free": 66437312,
        "total": 67108864,
        "used": 671552
    },
    "supportInfo": "/api/lunasa/hsms/123456/supportInfo",
    "tamper": "/api/lunasa/hsms/123456/tamper",
    "timeInfo": {
        "difference": "0 s",
        "host": "2025-06-03 05:05:09 UTC",
        "hsm": "2025-06-03 05:05:16 UTC"
    },
    "tokens": "/api/lunasa/hsms/123456/tokens",
    "updates": "/api/lunasa/hsms/123456/updates",
    "utilization": "/api/lunasa/hsms/123456/utilization"
}

See Also

GET /api/lunasa/hsms/{hsmid}/counter
GET /api/lunasa/hsms/{hsmid}/licenses
GET /api/lunasa/hsms/{hsmid}/partitions
GET /api/lunasa/hsms/{hsmid}/policies
GET /api/lunasa/hsms/{hsmid}/roles
GET /api/lunasa/hsms/{hsmid}/updates
GET /api/lunasa/hsms/{hsmid}/peds
GET /api/lunasa/hsms/{hsmid}/counter
GET /api/lunasa/hsms/{hsmid}/certificate
GET /api/lunasa/hsms/{hsmid}/actions
GET /api/lunasa/hsms/{hsmid}/firmware
GET /api/lunasa/hsms/{hsmid}/tamper
GET /api/lunasa/hsms/{hsmid}/metrics
GET /api/lunasa/hsms/{hsmid}/supportInfo