REST API  4.0.0
REST API for SafeNet Network HSMs
GET /api/lunasa/hsms/{hsmid}/capabilities

GET /api/lunasa/hsms/{hsmid}/capabilities

Gets all capabilities associated with the HSM.

Parameters

hsmid

The serial number of the HSM of interest

Use: Required

JSON Schema:

   Object
   type: string

Responses

200

A list of all capabilities associated with the appliance. The list includes unique identifiers that can be used to get more specific information.

JSON Schema: HSM Capabilities

400

Unexpected error

404

HSM does not exist.

Example Request

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

Example Result

{
    "capabilities": [
        {
            "id": "0",
            "name": "Enable PIN-based authentication",
            "url": "/api/lunasa/hsms/117290/capabilities/0"
        },
        {
            "id": "1",
            "name": "Enable PED-based authentication",
            "url": "/api/lunasa/hsms/117290/capabilities/1"
        },
        {
            "id": "2",
            "name": "Performance level",
            "url": "/api/lunasa/hsms/117290/capabilities/2"
        },
        {
            "id": "4",
            "name": "Enable domestic mechanisms & key sizes",
            "url": "/api/lunasa/hsms/117290/capabilities/4"
        },
        {
            "id": "6",
            "name": "Enable masking",
            "url": "/api/lunasa/hsms/117290/capabilities/6"
        },
        {
            "id": "7",
            "name": "Enable cloning",
            "url": "/api/lunasa/hsms/117290/capabilities/7"
        },
        {
            "id": "8",
            "name": "Enable special cloning certificate",
            "url": "/api/lunasa/hsms/117290/capabilities/8"
        },
        {
            "id": "9",
            "name": "Enable full (non-backup) functionality",
            "url": "/api/lunasa/hsms/117290/capabilities/9"
        },
        {
            "id": "12",
            "name": "Enable non-FIPS algorithms",
            "url": "/api/lunasa/hsms/117290/capabilities/12"
        },
        {
            "id": "15",
            "name": "Enable SO reset of partition PIN",
            "url": "/api/lunasa/hsms/117290/capabilities/15"
        },
        {
            "id": "16",
            "name": "Enable network replication",
            "url": "/api/lunasa/hsms/117290/capabilities/16"
        },
        {
            "id": "17",
            "name": "Enable Korean Algorithms",
            "url": "/api/lunasa/hsms/117290/capabilities/17"
        },
        {
            "id": "18",
            "name": "FIPS evaluated",
            "url": "/api/lunasa/hsms/117290/capabilities/18"
        },
        {
            "id": "19",
            "name": "Manufacturing Token",
            "url": "/api/lunasa/hsms/117290/capabilities/19"
        },
        {
            "id": "20",
            "name": "Enable Remote Authentication",
            "url": "/api/lunasa/hsms/117290/capabilities/20"
        },
        {
            "id": "21",
            "name": "Enable forcing user PIN change",
            "url": "/api/lunasa/hsms/117290/capabilities/21"
        },
        {
            "id": "22",
            "name": "Enable offboard storage",
            "url": "/api/lunasa/hsms/117290/capabilities/22"
        },
        {
            "id": "23",
            "name": "Enable partition groups",
            "url": "/api/lunasa/hsms/117290/capabilities/23"
        },
        {
            "id": "25",
            "name": "Enable remote PED usage",
            "url": "/api/lunasa/hsms/117290/capabilities/25"
        },
        {
            "id": "26",
            "name": "Enable External Storage of MTK Split",
            "url": "/api/lunasa/hsms/117290/capabilities/26"
        },
        {
            "id": "27",
            "name": "HSM non-volatile storage space",
            "url": "/api/lunasa/hsms/117290/capabilities/27"
        },
        {
            "id": "29",
            "name": "Enable Acceleration",
            "url": "/api/lunasa/hsms/117290/capabilities/29"
        },
        {
            "id": "30",
            "name": "Enable unmasking",
            "url": "/api/lunasa/hsms/117290/capabilities/30"
        },
        {
            "id": "31",
            "name": "Enable FW5 compatibility mode",
            "url": "/api/lunasa/hsms/117290/capabilities/31"
        },
        {
            "id": "33",
            "name": "Maximum number of partitions",
            "url": "/api/lunasa/hsms/117290/capabilities/33"
        },
        {
            "id": "34",
            "name": "Enable ECIES support",
            "url": "/api/lunasa/hsms/117290/capabilities/34"
        },
        {
            "id": "35",
            "name": "Enable Single Domain",
            "url": "/api/lunasa/hsms/117290/capabilities/35"
        },
        {
            "id": "36",
            "name": "Enable Unified PED Key",
            "url": "/api/lunasa/hsms/117290/capabilities/36"
        },
        {
            "id": "37",
            "name": "Enable MofN",
            "url": "/api/lunasa/hsms/117290/capabilities/37"
        },
        {
            "id": "38",
            "name": "Enable small form factor backup/restore",
            "url": "/api/lunasa/hsms/117290/capabilities/38"
        },
        {
            "id": "39",
            "name": "Enable Secure Trusted Channel",
            "url": "/api/lunasa/hsms/117290/capabilities/39"
        },
        {
            "id": "40",
            "name": "Enable decommission on tamper",
            "url": "/api/lunasa/hsms/117290/capabilities/40"
        },
        {
            "id": "41",
            "name": "Enable Per-Partition SO",
            "url": "/api/lunasa/hsms/117290/capabilities/41"
        },
        {
            "id": "42",
            "name": "Enable partition re-initialize",
            "url": "/api/lunasa/hsms/117290/capabilities/42"
        }
    ]
}

See Also

GET /api/lunasa/hsms/{hsmid}/capabilities/{capabilityid}