![]() |
REST API
4.0.0
REST API for SafeNet Network HSMs
|
Object
apiVersion: Object
type: integer
description: apiVersion is the revision of the REST API service.
cipherList: Object
type: string
description: cipherList is the cipher suite the REST API service is to
accept for applications requesting connection to the web server.
cipherList is a sub-set of the ciphers known to the REST
API service.
curveName: Object
type: string
description: curveName is the name of the elliptic curve to use for an
ECDSA-based certificate. This parameter does not apply and should
be disregarded for RSA key types. If no curveName is
provided for ECDSA-based certificates, the REST API uses
"secp384r1" as the default curve.
ipAddress: Object
type: string
description: ipAddress is the network address to the REST API service.
keyType: Object
type: string
description: keyType is the type of key to use for the certificate used to secure
the REST API service. The choices are: rsa and ecc.
keySize: Object
type: integer
description: keySize is the number of bits used in the key associated with the
certificate. Valid RSA key sizes are: 2048, 3072 and 4096.
This attribute does not apply on PUT and PATCH operations for ECC
key types but does show the key size on GET operations.
netDevice: Object
type: string
description: netDevice is the interface to which the REST API service is bound.
Valid interfaces are: eth0, eth1, eth2, eth3, all, all_ipv6, bond0
and bond1.
port: Object
type: integer
description: port is the logical end-point number reserved for the REST API service.
The port must be within the range: 80 to 65535.
threads: Object
type: integer
description: threads is the number of simultaneous connections the REST API service
supports. A small number of threads implies restricted administrative
access to the appliance.