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

Hostnames

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.