Skip to content
Cloudflare API
Start here
API Reference
Origin TLS Client Auth

Hostname Certificates

List Certificates
client.originTLSClientAuth.hostnameCertificates.list(HostnameCertificateListParams { zone_id } params, RequestOptionsoptions?): SinglePage<HostnameCertificateListResponse { id, certificate, expires_on, 5 more } >
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Get the Hostname Client Certificate
client.originTLSClientAuth.hostnameCertificates.get(stringcertificateId, HostnameCertificateGetParams { zone_id } params, RequestOptionsoptions?): HostnameCertificateGetResponse { id, certificate, expires_on, 5 more }
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
Upload a Hostname Client Certificate
client.originTLSClientAuth.hostnameCertificates.create(HostnameCertificateCreateParams { zone_id, certificate, private_key } params, RequestOptionsoptions?): HostnameCertificateCreateResponse { id, certificate, expires_on, 5 more }
POST/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Delete Hostname Client Certificate
client.originTLSClientAuth.hostnameCertificates.delete(stringcertificateId, HostnameCertificateDeleteParams { zone_id } params, RequestOptionsoptions?): HostnameCertificateDeleteResponse { id, certificate, expires_on, 5 more }
DELETE/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
ModelsExpand Collapse
Certificate { id, certificate, expires_on, 5 more }
id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

expires_on?: string

The date when the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time
HostnameCertificateListResponse { id, certificate, expires_on, 5 more }
id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

expires_on?: string

The date when the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time
HostnameCertificateGetResponse { id, certificate, expires_on, 5 more }
id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

expires_on?: string

The date when the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time
HostnameCertificateCreateResponse { id, certificate, expires_on, 5 more }
id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

expires_on?: string

The date when the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time
HostnameCertificateDeleteResponse { id, certificate, expires_on, 5 more }
id?: string

Identifier.

maxLength32
certificate?: string

The hostname certificate.

expires_on?: string

The date when the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

serial_number?: string

The serial number on the uploaded certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate or the association.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on?: string

The time when the certificate was uploaded.

formatdate-time