Sign in

v1

latestOpenAPI 3.0.32026-07-17687987.2 KB
tls

Returns TLS configuration and its status

get/tls/status

Response

OK.

enabledboolean

enabled is the encryption (DoT/DoH/HTTPS) status

server_namestring

server_name is the hostname of your HTTPS/TLS server

force_httpsboolean

if true, forces HTTP->HTTPS redirect

port_httpsinteger

HTTPS port. If 0, HTTPS will be disabled.

port_dns_over_tlsinteger

DNS-over-TLS port. If 0, DoT will be disabled.

port_dns_over_quicinteger

DNS-over-QUIC port. If 0, DoQ will be disabled.

certificate_chainstring

Base64 string with PEM-encoded certificates chain

private_keystring

Base64 string with PEM-encoded private key

private_key_savedboolean

Set to true if the user has previously saved a private key as a string. This is used so that the server and the client don't have to send the private key between each other every time, which might lead to security issues.

certificate_pathstring

Path to certificate file

private_key_pathstring

Path to private key file

valid_certboolean

Set to true if the specified certificates chain is a valid chain of X509 certificates.

valid_chainboolean

Set to true if the specified certificates chain is verified and issued by a known CA.

subjectstring

The subject of the first certificate in the chain.

issuerstring

The issuer of the first certificate in the chain.

not_beforestring

The NotBefore field of the first certificate in the chain.

not_afterstring

The NotAfter field of the first certificate in the chain.

dns_namesstring[]

The value of SubjectAltNames field of the first certificate in the chain.

valid_keyboolean

Set to true if the key is a valid private key.

key_type'RSA' | 'ECDSA'

Key type.

warning_validationstring

A validation warning message with the issue description.

valid_pairboolean

Set to true if both certificate and private key are correct.

Example response

{
  "server_name": "example.org",
  "valid_cert": true,
  "valid_key": true,
  "key_type": "RSA",
  "subject": "CN=example.org",
  "not_before": "2019-01-31T10:47:32Z",
  "private_key": "private_key",
  "private_key_saved": true,
  "enabled": true,
  "certificate_chain": "certificate_chain",
  "private_key_path": "private_key_path",
  "issuer": "CN=Let's Encrypt Authority X3,O=Let's Encrypt,C=US",
  "not_after": "2019-05-01T10:47:32Z",
  "force_https": true,
  "certificate_path": "certificate_path",
  "warning_validation": "You have specified an empty certificate",
  "dns_names": [
    "*.example.org"
  ],
  "valid_pair": true,
  "valid_chain": true,
  "port_dns_over_tls": 853,
  "port_dns_over_quic": 784,
  "port_https": 443
}