Skip to content
Cloudflare API
Start here
API Reference

Origin TLS Client Auth

List Certificates
Deprecated
origin_tls_client_auth.list(OriginTLSClientAuthListParams**kwargs) -> SyncSinglePage[OriginTLSClientAuthListResponse]
GET/zones/{zone_id}/origin_tls_client_auth
Get Certificate Details
Deprecated
origin_tls_client_auth.get(strcertificate_id, OriginTLSClientAuthGetParams**kwargs) -> OriginTLSClientAuthGetResponse
GET/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
Upload Certificate
Deprecated
origin_tls_client_auth.create(OriginTLSClientAuthCreateParams**kwargs) -> OriginTLSClientAuthCreateResponse
POST/zones/{zone_id}/origin_tls_client_auth
Delete Certificate
Deprecated
origin_tls_client_auth.delete(strcertificate_id, OriginTLSClientAuthDeleteParams**kwargs) -> OriginTLSClientAuthDeleteResponse
DELETE/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
ModelsExpand Collapse
class OriginTLSClientAuthListResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class OriginTLSClientAuthGetResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class OriginTLSClientAuthCreateResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class OriginTLSClientAuthDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

Origin TLS Client AuthZone Certificates

List Certificates
origin_tls_client_auth.zone_certificates.list(ZoneCertificateListParams**kwargs) -> SyncSinglePage[ZoneCertificateListResponse]
GET/zones/{zone_id}/origin_tls_client_auth
Get Certificate Details
origin_tls_client_auth.zone_certificates.get(strcertificate_id, ZoneCertificateGetParams**kwargs) -> ZoneCertificateGetResponse
GET/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
Upload Certificate
origin_tls_client_auth.zone_certificates.create(ZoneCertificateCreateParams**kwargs) -> ZoneCertificateCreateResponse
POST/zones/{zone_id}/origin_tls_client_auth
Delete Certificate
origin_tls_client_auth.zone_certificates.delete(strcertificate_id, ZoneCertificateDeleteParams**kwargs) -> ZoneCertificateDeleteResponse
DELETE/zones/{zone_id}/origin_tls_client_auth/{certificate_id}
ModelsExpand Collapse
class ZoneAuthenticatedOriginPull: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

expires_on: Optional[datetime]

When the certificate from the authority expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["initializing", "pending_deployment", "pending_deletion", 4 more]]

Status of the certificate activation.

One of the following:
"initializing"
"pending_deployment"
"pending_deletion"
"active"
"deleted"
"deployment_timed_out"
"deletion_timed_out"
uploaded_on: Optional[datetime]

This is the time the certificate was uploaded.

formatdate-time
class ZoneCertificateListResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class ZoneCertificateGetResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class ZoneCertificateCreateResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

class ZoneCertificateDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The zone's leaf certificate.

enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

private_key: Optional[str]

The zone's private key.

Origin TLS Client AuthHostnames

Get the Hostname Status for Client Authentication
origin_tls_client_auth.hostnames.get(strhostname, HostnameGetParams**kwargs) -> AuthenticatedOriginPull
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}
Enable or Disable a Hostname for Client Authentication
origin_tls_client_auth.hostnames.update(HostnameUpdateParams**kwargs) -> SyncSinglePage[HostnameUpdateResponse]
PUT/zones/{zone_id}/origin_tls_client_auth/hostnames
ModelsExpand Collapse
class AuthenticatedOriginPull: …
cert_id: Optional[str]

Identifier.

maxLength32
cert_status: Optional[Literal["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"
cert_updated_at: Optional[datetime]

The time when the certificate was updated.

formatdate-time
cert_uploaded_on: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time
certificate: Optional[str]

The hostname certificate.

created_at: Optional[datetime]

The time when the certificate was created.

formatdate-time
enabled: Optional[bool]

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

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
hostname: Optional[str]

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

maxLength255
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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"
updated_at: Optional[datetime]

The time when the certificate was updated.

formatdate-time
class HostnameUpdateResponse: …
id: Optional[str]

Identifier.

maxLength32
cert_id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

enabled: Optional[bool]

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

hostname: Optional[str]

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

maxLength255
private_key: Optional[str]

The hostname certificate's private key.

Origin TLS Client AuthHostname Certificates

List Certificates
origin_tls_client_auth.hostname_certificates.list(HostnameCertificateListParams**kwargs) -> SyncSinglePage[HostnameCertificateListResponse]
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Get the Hostname Client Certificate
origin_tls_client_auth.hostname_certificates.get(strcertificate_id, HostnameCertificateGetParams**kwargs) -> HostnameCertificateGetResponse
GET/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
Upload a Hostname Client Certificate
origin_tls_client_auth.hostname_certificates.create(HostnameCertificateCreateParams**kwargs) -> HostnameCertificateCreateResponse
POST/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates
Delete Hostname Client Certificate
origin_tls_client_auth.hostname_certificates.delete(strcertificate_id, HostnameCertificateDeleteParams**kwargs) -> HostnameCertificateDeleteResponse
DELETE/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}
ModelsExpand Collapse
class Certificate: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time
class HostnameCertificateListResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time
class HostnameCertificateGetResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time
class HostnameCertificateCreateResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time
class HostnameCertificateDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32
certificate: Optional[str]

The hostname certificate.

expires_on: Optional[datetime]

The date when the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

serial_number: Optional[str]

The serial number on the uploaded certificate.

signature: Optional[str]

The type of hash used for the certificate.

status: Optional[Literal["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: Optional[datetime]

The time when the certificate was uploaded.

formatdate-time

Origin TLS Client AuthSettings

Get Enablement Setting for Zone
origin_tls_client_auth.settings.get(SettingGetParams**kwargs) -> SettingGetResponse
GET/zones/{zone_id}/origin_tls_client_auth/settings
Set Enablement for Zone
origin_tls_client_auth.settings.update(SettingUpdateParams**kwargs) -> SettingUpdateResponse
PUT/zones/{zone_id}/origin_tls_client_auth/settings
ModelsExpand Collapse
class SettingGetResponse: …
enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.

class SettingUpdateResponse: …
enabled: Optional[bool]

Indicates whether zone-level authenticated origin pulls is enabled.