TlsConfig

TlsConfig
TlsConfig
JSON Example
{
    "client_cert_ref": "string",
    "pki_profile_ref": "string",
    "skip_hostname_verification": false,
    "tls_mode": "string"
}
string
client_cert_ref
Optional

Client certificate for mutual TLS connection. Required when TLS mode is Mutual TLS. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
pki_profile_ref
Optional

PKI Profile used to validate the server certificate validation in One-way TLS and Mutual TLS. If this field is not set, the PKI Profile from System Configuration will be used. Effective when TLS Mode is One-way TLS or Mutual TLS. It is a reference to an object of type PKIProfile. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
skip_hostname_verification
Optional

Skip hostname verification on the server certificate, chain validation still applies. Effective when TLS Mode is One-way TLS or Mutual TLS. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
tls_mode
Optional

How TLS is used for this outbound connection. Certificate validation uses the Truststore PKI Profile (default Truststore PKI Profile from System Configuration). Enum options - TLS_MODE_NO_VERIFY, TLS_MODE_TLS, TLS_MODE_MTLS. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.