The TLS key pairs API endpoints support operations to retrieve the current Transport Layer Security (TLS)key pair, as well as to upload TLS PKCS12 key pairs for encrypting and decrypting data.

Data model

TlsKeyPairView - A TLS Key Pair.

Property Type Description
certChain * array[CertView] (Read-only) TLS KeyPair Certificate Chain.
id * string (Read-only) TLS KeyPair Id.

CertView - Information associated with a certificate.

Property Type Description
alias string The alias for the certificate.
expires string (Read-only) The time and date at which the certificate expires.
fileData string (Read-only) The certificate’s data.
id string (Read-only) The ID of the certificate.
issuerDN string (Read-only) The issuerDN of the certificate.
serialNumber string (Read-only) The serial number of the certificate.
signatureAlgorithm string (Read-only) The signature algorithm of the certificate.
status * string A high-level status for the certificate.
subjectAlternativeNames array[string] (Read-only) The certificate’s subject alternative names.
subjectDN string (Read-only) The subjectDN of the certificate.
type string The type of certificate.
validFrom string (Read-only) The time and date from which the certificate is valid.
version integer (Read-only) The version of the certificate.

TlsKeyPairImportView - A TLS Key Pair.

Property Type Description
alias * string The alias for the private key and certificate chain.
filePassword * string The password for the PKCS12 file.
keyPassword * string The password for the private key.
pkcs12 * string The PKCS12 data.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request, or your license is exceeded.
404 The requested resource was not found.
422 The requested could not be completed because of validation error(s).