APIRef_tm_sys_crypto_keyΒΆ

mgmt/tm/sys/crypto/key

/tm/sys/crypto

Key configuration

REST Endpoints

Collection URI
/mgmt/tm/sys/crypto/key
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/sys/crypto/key/~resource id
Resource Methods
OPTIONS, GET, DELETE, POST
Resource Natural Key
name

Properties

Name Type Default Value Required Access Description
adminEmailAddress string   optional read/write Specifies the administrator email address to be used when creating the certificate signing request.
appService string   optional read/write  
challengePassword string   optional read/write Specifies the PKCS#9 challenge password used when creating the certificate signing request.
city string   optional read/write Specifies the x509 city to associate.
commonName string   optional read/write Specifies the x509 common name to be associated.
consumer string ltm optional read/write Specifies the TMOS component which will be making use of this.
country string   optional read/write Specifies the 2 letter x509 country code to associate.
curveName string none optional read/write Specifies the curve name to create elliptic curve (EC) key.
emailAddress string   optional read/write Specifies the email address to associate.
fromLocalFile string   optional read/write Obtain the object from a local file on disk.
fromUrl string   optional read/write Obtain the object from a remote server via the specified URL.
keySize string 1024 optional read/write Size in bits of associated key.
keyType string rsa-private optional read/write Specifies the cryptographic type of the key.
lifetime integer   optional read/write Specifies the amount of time this certificate will remain valid.
organization string   optional read/write Specifies the x509 organization name to associate.
ou string   optional read/write Specifies the organizational unit to associate.
passphrase string   optional read/write An optional passphrase for use with protected keys.
securityType string normal optional read/write Specifies the security type to use.
state string   optional read/write Specifies the x509 state to associate.
subjectAlternativeName string   optional read/write Specifies the standard X.509 extension as shown in RFC 2459.
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.