Skip to content
Cloudflare API
Start here
API Reference

Origin TLS Client Auth

List Certificates
Deprecated
client.OriginTLSClientAuth.List(ctx, query) (*SinglePage[OriginTLSClientAuthListResponse], error)
GET/zones/{zone_id}/origin_tls_client_auth
Get Certificate Details
Deprecated
client.OriginTLSClientAuth.Get(ctx, certificateID, query) (*OriginTLSClientAuthGetResponse, error)
GET/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
Upload Certificate
Deprecated
client.OriginTLSClientAuth.New(ctx, params) (*OriginTLSClientAuthNewResponse, error)
POST/zones/{zone_id}/origin_tls_client_auth
Delete Certificate
Deprecated
client.OriginTLSClientAuth.Delete(ctx, certificateID, body) (*OriginTLSClientAuthDeleteResponse, error)
DELETE/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Origin TLS Client AuthZone Certificates

List Certificates
client.OriginTLSClientAuth.ZoneCertificates.List(ctx, query) (*SinglePage[ZoneCertificateListResponse], error)
GET/zones/{zone_id}/origin_tls_client_auth
Get Certificate Details
client.OriginTLSClientAuth.ZoneCertificates.Get(ctx, certificateID, query) (*ZoneCertificateGetResponse, error)
GET/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
Upload Certificate
client.OriginTLSClientAuth.ZoneCertificates.New(ctx, params) (*ZoneCertificateNewResponse, error)
POST/zones/{zone_id}/origin_tls_client_auth
Delete Certificate
client.OriginTLSClientAuth.ZoneCertificates.Delete(ctx, certificateID, body) (*ZoneCertificateDeleteResponse, error)
DELETE/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
ModelsExpand Collapse
type ZoneAuthenticatedOriginPull struct{…}
ID stringoptional

Identifier.

maxLength32
Certificate stringoptional

The zone's leaf certificate.

ExpiresOn Timeoptional

When the certificate from the authority expires.

formatdate-time
Issuer stringoptional

The certificate authority that issued the certificate.

Signature stringoptional

The type of hash used for the certificate.

Status ZoneAuthenticatedOriginPullStatusoptional

Status of the certificate activation.

One of the following:
const ZoneAuthenticatedOriginPullStatusInitializing ZoneAuthenticatedOriginPullStatus = "initializing"
const ZoneAuthenticatedOriginPullStatusPendingDeployment ZoneAuthenticatedOriginPullStatus = "pending_deployment"
const ZoneAuthenticatedOriginPullStatusPendingDeletion ZoneAuthenticatedOriginPullStatus = "pending_deletion"
const ZoneAuthenticatedOriginPullStatusActive ZoneAuthenticatedOriginPullStatus = "active"
const ZoneAuthenticatedOriginPullStatusDeleted ZoneAuthenticatedOriginPullStatus = "deleted"
const ZoneAuthenticatedOriginPullStatusDeploymentTimedOut ZoneAuthenticatedOriginPullStatus = "deployment_timed_out"
const ZoneAuthenticatedOriginPullStatusDeletionTimedOut ZoneAuthenticatedOriginPullStatus = "deletion_timed_out"
UploadedOn Timeoptional

This is the time the certificate was uploaded.

formatdate-time

Origin TLS Client AuthHostnames

Get the Hostname Status for Client Authentication
client.OriginTLSClientAuth.Hostnames.Get(ctx, hostname, query) (*AuthenticatedOriginPull, error)
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}
Enable or Disable a Hostname for Client Authentication
client.OriginTLSClientAuth.Hostnames.Update(ctx, params) (*SinglePage[HostnameUpdateResponse], error)
PUT/zones/{zone_id}/origin_tls_client_auth/hostnames
ModelsExpand Collapse
type AuthenticatedOriginPull struct{…}
CERTID stringoptional

Identifier.

maxLength32
CERTStatus AuthenticatedOriginPullCERTStatusoptional

Status of the certificate or the association.

One of the following:
const AuthenticatedOriginPullCERTStatusInitializing AuthenticatedOriginPullCERTStatus = "initializing"
const AuthenticatedOriginPullCERTStatusPendingDeployment AuthenticatedOriginPullCERTStatus = "pending_deployment"
const AuthenticatedOriginPullCERTStatusPendingDeletion AuthenticatedOriginPullCERTStatus = "pending_deletion"
const AuthenticatedOriginPullCERTStatusActive AuthenticatedOriginPullCERTStatus = "active"
const AuthenticatedOriginPullCERTStatusDeleted AuthenticatedOriginPullCERTStatus = "deleted"
const AuthenticatedOriginPullCERTStatusDeploymentTimedOut AuthenticatedOriginPullCERTStatus = "deployment_timed_out"
const AuthenticatedOriginPullCERTStatusDeletionTimedOut AuthenticatedOriginPullCERTStatus = "deletion_timed_out"
CERTUpdatedAt Timeoptional

The time when the certificate was updated.

formatdate-time
CERTUploadedOn Timeoptional

The time when the certificate was uploaded.

formatdate-time
Certificate stringoptional

The hostname certificate.

CreatedAt Timeoptional

The time when the certificate was created.

formatdate-time
Enabled booloptional

Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.

ExpiresOn Timeoptional

The date when the certificate expires.

formatdate-time
Hostname stringoptional

The hostname on the origin for which the client certificate uploaded will be used.

maxLength255
Issuer stringoptional

The certificate authority that issued the certificate.

SerialNumber stringoptional

The serial number on the uploaded certificate.

Signature stringoptional

The type of hash used for the certificate.

Status AuthenticatedOriginPullStatusoptional

Status of the certificate or the association.

One of the following:
const AuthenticatedOriginPullStatusInitializing AuthenticatedOriginPullStatus = "initializing"
const AuthenticatedOriginPullStatusPendingDeployment AuthenticatedOriginPullStatus = "pending_deployment"
const AuthenticatedOriginPullStatusPendingDeletion AuthenticatedOriginPullStatus = "pending_deletion"
const AuthenticatedOriginPullStatusActive AuthenticatedOriginPullStatus = "active"
const AuthenticatedOriginPullStatusDeleted AuthenticatedOriginPullStatus = "deleted"
const AuthenticatedOriginPullStatusDeploymentTimedOut AuthenticatedOriginPullStatus = "deployment_timed_out"
const AuthenticatedOriginPullStatusDeletionTimedOut AuthenticatedOriginPullStatus = "deletion_timed_out"
UpdatedAt Timeoptional

The time when the certificate was updated.

formatdate-time

Origin TLS Client AuthHostname Certificates

List Certificates
client.OriginTLSClientAuth.HostnameCertificates.List(ctx, query) (*SinglePage[HostnameCertificateListResponse], error)
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Get the Hostname Client Certificate
client.OriginTLSClientAuth.HostnameCertificates.Get(ctx, certificateID, query) (*HostnameCertificateGetResponse, error)
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
Upload a Hostname Client Certificate
client.OriginTLSClientAuth.HostnameCertificates.New(ctx, params) (*HostnameCertificateNewResponse, error)
POST/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Delete Hostname Client Certificate
client.OriginTLSClientAuth.HostnameCertificates.Delete(ctx, certificateID, body) (*HostnameCertificateDeleteResponse, error)
DELETE/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
ModelsExpand Collapse
type Certificate struct{…}
ID stringoptional

Identifier.

maxLength32
Certificate stringoptional

The hostname certificate.

ExpiresOn Timeoptional

The date when the certificate expires.

formatdate-time
Issuer stringoptional

The certificate authority that issued the certificate.

SerialNumber stringoptional

The serial number on the uploaded certificate.

Signature stringoptional

The type of hash used for the certificate.

Status CertificateStatusoptional

Status of the certificate or the association.

One of the following:
const CertificateStatusInitializing CertificateStatus = "initializing"
const CertificateStatusPendingDeployment CertificateStatus = "pending_deployment"
const CertificateStatusPendingDeletion CertificateStatus = "pending_deletion"
const CertificateStatusActive CertificateStatus = "active"
const CertificateStatusDeleted CertificateStatus = "deleted"
const CertificateStatusDeploymentTimedOut CertificateStatus = "deployment_timed_out"
const CertificateStatusDeletionTimedOut CertificateStatus = "deletion_timed_out"
UploadedOn Timeoptional

The time when the certificate was uploaded.

formatdate-time

Origin TLS Client AuthSettings

Get Enablement Setting for Zone
client.OriginTLSClientAuth.Settings.Get(ctx, query) (*SettingGetResponse, error)
GET/zones/{zone_id}/origin_tls_client_auth/settings
Set Enablement for Zone
client.OriginTLSClientAuth.Settings.Update(ctx, params) (*SettingUpdateResponse, error)
PUT/zones/{zone_id}/origin_tls_client_auth/settings