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

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}

Gets the information associated with a specific partition.

User Privileges

Users with the following role privileges can perform this command:

  • admin
  • operator
  • monitor

Parameters

hsmid

The serial number of the HSM of interest.

Use: Required

JSON Schema:

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

partitionid

The identifier of the partition of interest

Use: Required

JSON Schema:

   Object
   type: integer
   format: int64
   minimum: 1000000
   maximum: 99999999999999999

Responses

200

Partition details

JSON Schema: Partition description

400

FRAMEWORK_BAD_REQUEST

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

404

HSM or partition does not exist.

Example Request

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

Example Result

{
    "capabilities": "/api/lunasa/hsms/123456/partitions/9876543211234/capabilities",
    "domains": "/api/lunasa/hsms/123456/partitions/9876543211234/domains",
    "indirect": "/api/lunasa/hsms/123456/partitions/9876543211234/indirect",
    "label": "",
    "loggedIn": "nobody",
    "name": "test_partition",
    "object": "/api/lunasa/hsms/123456/partitions/9876543211234/object",
    "objectCount": 0,
    "policies": "/api/lunasa/hsms/123456/partitions/9876543211234/policies",
    "roles": "/api/lunasa/hsms/123456/partitions/9876543211234/roles",
    "sff": "/api/lunasa/hsms/123456/partitions/9876543211234/sff",
    "smk": "/api/lunasa/hsms/123456/partitions/9876543211234/smk",
    "soChangePasswordAttemptsLeft": 0,
    "state": "zeroized",
    "stc": "/api/lunasa/hsms/123456/partitions/9876543211234/stc",
    "storageSpace": {
        "free": 324562,
        "total": 324562,
        "used": 0
    },
    "utilization": "/api/lunasa/hsms/123456/partitions/9876543211234/utilization",
    "version": "1"
}