Introduction

This section of API allows to manage TLS certificates.

TLS Certificate Model

Example

{
  "tls_certificate": {
    "id": 1,
    "name": "friendly_name",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIB0DCCAXagAwIBAgIEGCRJozAKBggqhkjOPQQDAjBHMQswCQYDVQQGEwJQTDEU\nMBIGA1UEAwwLZXhhbXBsZS5jb20xCjAIBgNVBAgMAWExCjAIBgNVBAcMAWExCjAI\nBgNVBAoMAWEwHhcNMjQwMjIxMTAxMjIzWhcNMjYwMjIwMTAxMjIzWjBHMQswCQYD\nVQQGEwJQTDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xCjAIBgNVBAgMAWExCjAIBgNV\nBAcMAWExCjAIBgNVBAoMAWEwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATUO4FY\n0Lz4RKB7t3IpVOAWDxaKd9KAA4rvxSdUEGkxgSPEaJDorau6+nnLlDZ65UiN8sxV\nJzcWYEv11HWd+iWvo1AwTjAdBgNVHQ4EFgQUmRCaoeO5jxfa+IP5ZrJXggc50VEw\nHwYDVR0jBBgwFoAUmRCaoeO5jxfa+IP5ZrJXggc50VEwDAYDVR0TBAUwAwEB/zAK\nBggqhkjOPQQDAgNIADBFAiBgVpb0C4upyr248a2VLsee6qVW3UnCi9W1bD+zdL4R\nagIhAP/yKMLgMuMc6dll7PcQb2Z+4N+LgROT5zKZVnaoh0+a\n-----END CERTIFICATE-----",
    "private_key": "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIE5Ws2f35giW8BXQnOU8eNwohRW1rwaiJiFFBIC40ShLoAoGCCqGSM49\nAwEHoUQDQgAE1DuBWNC8+ESge7dyKVTgFg8WinfSgAOK78UnVBBpMYEjxGiQ6K2r\nuvp5y5Q2euVIjfLMVSc3FmBL9dR1nfolrw==\n-----END EC PRIVATE KEY-----",
    "certificate_type": "EC",
    "expires_at": "2026-02-20T10:12:23.000000Z",
    "common_names": [
      "example.com"
    ],
    "created_at": "2024-02-21T10:14:16.593398Z",
    "updated_at": "2024-02-21T10:14:16.593398Z"
  }
}

Definition

Key	Type	Optional	Read-only	Description
id	integer	no	yes
name	string	yes	no	Name of the certificate
certificate	string	no	no	Certificate itself
private_key	string	no	no	Private key used to sign the certificate (is returned as "*****")
certificate_type	string	no	yes	Certificate type (RSA, EC)
expires_at	datetime	no	yes	Expiration time of the certificate
common_names	string[]	no	yes	Certificate common names + SAN domains
created_at	datetime	no	yes	Time of record creation
updated_at	datetime	no	yes	Time of record last update

TLS Certificate Model#

Example#

Definition#

TLS Certificate Model

Example

Definition