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

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

Gets the SMS Key state.

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

smkid

The identifier of the smk of interest

Use: Required

JSON Schema:

   Object
   type: string
   minLength: 1
   maxLength: 32
   pattern: ^[a-zA-Z0-9_.-]*$

Responses

200

JSON Schema: SMK Key

400

FRAMEWORK_BAD_REQUEST

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

HSMPLUGIN_PARTITION_VERSION_INVALID

HSMPLUGIN_FUNC_NOT_SUPPORTED

Partition or Firmware does not support SMK.

404

HSMPLUGIN_INVALID_HSM

HSMPLUGIN_INVALID_PARTITION

HSMPLUGIN_INVALID_SMKID

HSM or Partition or SMK key does not exist.

Example Request

   GET
   https://1.2.3.4:8443/api/lunasa/hsms/123456/partitions/1234567891012/smk/smk-fw7-primary

Example Result

{
    "actions": "/api/lunasa/hsms/123456/partitions/1234567891012/smk/smk-fw7-primary/actions"
    "id": "smk-fw7-primary",
    "state": "Not Initialized"
}

See Also

GET /api/lunasa/hsms/{hsmid}/partitions/{partitionid}/smk/{smkid}/actions