TLS Certificates
Create TLS Certificate
Upload a new TLS certificate
Request
POST /tls_certificates
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
certificate_pem | string | chain of PEM-encoded certificates, leaf first. See Certificate Bundles. |
private_key_pem | string | private key for the TLS certificate, PEM-encoded. See Private Keys. |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TLS certificate |
uri | string | URI of the TLS certificate API resource |
created_at | string | timestamp when the TLS certificate was created, RFC 3339 format |
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
certificate_pem | string | chain of PEM-encoded certificates, leaf first. See Certificate Bundles. |
subject_common_name | string | subject common name from the leaf of this TLS certificate |
subject_alternative_names | TLSCertificateSANs | subject alternative names (SANs) from the leaf of this TLS certificate |
issued_at | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
not_before | string | timestamp when this TLS certificate becomes valid, RFC 3339 format |
not_after | string | timestamp when this TLS certificate becomes invalid, RFC 3339 format |
key_usages | List<string> | set of actions the private key of this TLS certificate can be used for |
extended_key_usages | List<string> | extended set of actions the private key of this TLS certificate can be used for |
private_key_type | string | type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519. |
issuer_common_name | string | issuer common name from the leaf of this TLS certificate |
serial_number | string | serial number of the leaf of this TLS certificate |
subject_organization | string | subject organization from the leaf of this TLS certificate |
subject_organizational_unit | string | subject organizational unit from the leaf of this TLS certificate |
subject_locality | string | subject locality from the leaf of this TLS certificate |
subject_province | string | subject province from the leaf of this TLS certificate |
subject_country | string | subject country from the leaf of this TLS certificate |
TLSCertificateSANs fields
| Name | Type | Description |
|---|---|---|
dns_names | List<string> | set of additional domains (including wildcards) this TLS certificate is valid for |
ips | List<string> | set of IP addresses this TLS certificate is also valid for |
Delete TLS Certificate
Delete a TLS certificate
Request
DELETE /tls_certificates/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get TLS Certificate
Get detailed information about a TLS certificate
Request
GET /tls_certificates/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TLS certificate |
uri | string | URI of the TLS certificate API resource |
created_at | string | timestamp when the TLS certificate was created, RFC 3339 format |
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
certificate_pem | string | chain of PEM-encoded certificates, leaf first. See Certificate Bundles. |
subject_common_name | string | subject common name from the leaf of this TLS certificate |
subject_alternative_names | TLSCertificateSANs | subject alternative names (SANs) from the leaf of this TLS certificate |
issued_at | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
not_before | string | timestamp when this TLS certificate becomes valid, RFC 3339 format |
not_after | string | timestamp when this TLS certificate becomes invalid, RFC 3339 format |
key_usages | List<string> | set of actions the private key of this TLS certificate can be used for |
extended_key_usages | List<string> | extended set of actions the private key of this TLS certificate can be used for |
private_key_type | string | type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519. |
issuer_common_name | string | issuer common name from the leaf of this TLS certificate |
serial_number | string | serial number of the leaf of this TLS certificate |
subject_organization | string | subject organization from the leaf of this TLS certificate |
subject_organizational_unit | string | subject organizational unit from the leaf of this TLS certificate |
subject_locality | string | subject locality from the leaf of this TLS certificate |
subject_province | string | subject province from the leaf of this TLS certificate |
subject_country | string | subject country from the leaf of this TLS certificate |
TLSCertificateSANs fields
| Name | Type | Description |
|---|---|---|
dns_names | List<string> | set of additional domains (including wildcards) this TLS certificate is valid for |
ips | List<string> | set of IP addresses this TLS certificate is also valid for |
List TLS Certificates
List all TLS certificates on this account
Request
GET /tls_certificates
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
tls_certificates | TLSCertificate | the list of all TLS certificates on this account |
uri | string | URI of the TLS certificates list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
TLSCertificate fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TLS certificate |
uri | string | URI of the TLS certificate API resource |
created_at | string | timestamp when the TLS certificate was created, RFC 3339 format |
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
certificate_pem | string | chain of PEM-encoded certificates, leaf first. See Certificate Bundles. |
subject_common_name | string | subject common name from the leaf of this TLS certificate |
subject_alternative_names | TLSCertificateSANs | subject alternative names (SANs) from the leaf of this TLS certificate |
issued_at | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
not_before | string | timestamp when this TLS certificate becomes valid, RFC 3339 format |
not_after | string | timestamp when this TLS certificate becomes invalid, RFC 3339 format |
key_usages | List<string> | set of actions the private key of this TLS certificate can be used for |
extended_key_usages | List<string> | extended set of actions the private key of this TLS certificate can be used for |
private_key_type | string | type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519. |
issuer_common_name | string | issuer common name from the leaf of this TLS certificate |
serial_number | string | serial number of the leaf of this TLS certificate |
subject_organization | string | subject organization from the leaf of this TLS certificate |
subject_organizational_unit | string | subject organizational unit from the leaf of this TLS certificate |
subject_locality | string | subject locality from the leaf of this TLS certificate |
subject_province | string | subject province from the leaf of this TLS certificate |
subject_country | string | subject country from the leaf of this TLS certificate |
TLSCertificateSANs fields
| Name | Type | Description |
|---|---|---|
dns_names | List<string> | set of additional domains (including wildcards) this TLS certificate is valid for |
ips | List<string> | set of IP addresses this TLS certificate is also valid for |
Update TLS Certificate
Update attributes of a TLS Certificate by ID
Request
PATCH /tls_certificates/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | |
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TLS certificate |
uri | string | URI of the TLS certificate API resource |
created_at | string | timestamp when the TLS certificate was created, RFC 3339 format |
description | string | human-readable description of this TLS certificate. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes. |
certificate_pem | string | chain of PEM-encoded certificates, leaf first. See Certificate Bundles. |
subject_common_name | string | subject common name from the leaf of this TLS certificate |
subject_alternative_names | TLSCertificateSANs | subject alternative names (SANs) from the leaf of this TLS certificate |
issued_at | string | timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded |
not_before | string | timestamp when this TLS certificate becomes valid, RFC 3339 format |
not_after | string | timestamp when this TLS certificate becomes invalid, RFC 3339 format |
key_usages | List<string> | set of actions the private key of this TLS certificate can be used for |
extended_key_usages | List<string> | extended set of actions the private key of this TLS certificate can be used for |
private_key_type | string | type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519. |
issuer_common_name | string | issuer common name from the leaf of this TLS certificate |
serial_number | string | serial number of the leaf of this TLS certificate |
subject_organization | string | subject organization from the leaf of this TLS certificate |
subject_organizational_unit | string | subject organizational unit from the leaf of this TLS certificate |
subject_locality | string | subject locality from the leaf of this TLS certificate |
subject_province | string | subject province from the leaf of this TLS certificate |
subject_country | string | subject country from the leaf of this TLS certificate |
TLSCertificateSANs fields
| Name | Type | Description |
|---|---|---|
dns_names | List<string> | set of additional domains (including wildcards) this TLS certificate is valid for |
ips | List<string> | set of IP addresses this TLS certificate is also valid for |