--- title: Origin TLS Client Auth --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Origin TLS Client Auth ##### [List Certificates](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/methods/list) Deprecated origin\_tls\_client\_auth.list(OriginTLSClientAuthListParams\*\*kwargs) -> SyncSinglePage\[[OriginTLSClientAuthListResponse]()] GET/zones/{zone\_id}/origin\_tls\_client\_auth ##### [Get Certificate Details](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/methods/get) Deprecated origin\_tls\_client\_auth.get(strcertificate\_id, OriginTLSClientAuthGetParams\*\*kwargs) -> [OriginTLSClientAuthGetResponse]() GET/zones/{zone\_id}/origin\_tls\_client\_auth/{certificate\_id} ##### [Upload Certificate](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/methods/create) Deprecated origin\_tls\_client\_auth.create(OriginTLSClientAuthCreateParams\*\*kwargs) -> [OriginTLSClientAuthCreateResponse]() POST/zones/{zone\_id}/origin\_tls\_client\_auth ##### [Delete Certificate](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/methods/delete) 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] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth%20%3E%20(model)%20origin_tls_client_auth_list_response%20%3E%20(schema)>)
class OriginTLSClientAuthGetResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth%20%3E%20(model)%20origin_tls_client_auth_get_response%20%3E%20(schema)>)
class OriginTLSClientAuthCreateResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth%20%3E%20(model)%20origin_tls_client_auth_create_response%20%3E%20(schema)>)
class OriginTLSClientAuthDeleteResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth%20%3E%20(model)%20origin_tls_client_auth_delete_response%20%3E%20(schema)>) #### Origin TLS Client AuthZone Certificates ##### [List Certificates](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/zone_certificates/methods/list) origin\_tls\_client\_auth.zone\_certificates.list(ZoneCertificateListParams\*\*kwargs) -> SyncSinglePage\[[ZoneCertificateListResponse]()] GET/zones/{zone\_id}/origin\_tls\_client\_auth ##### [Get Certificate Details](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/zone_certificates/methods/get) origin\_tls\_client\_auth.zone\_certificates.get(strcertificate\_id, ZoneCertificateGetParams\*\*kwargs) -> [ZoneCertificateGetResponse]() GET/zones/{zone\_id}/origin\_tls\_client\_auth/{certificate\_id} ##### [Upload Certificate](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/zone_certificates/methods/create) origin\_tls\_client\_auth.zone\_certificates.create(ZoneCertificateCreateParams\*\*kwargs) -> [ZoneCertificateCreateResponse]() POST/zones/{zone\_id}/origin\_tls\_client\_auth ##### [Delete Certificate](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/zone_certificates/methods/delete) 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] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property expires\_on: Optional\[datetime] When the certificate from the authority expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate activation. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] This is the time the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.zone_certificates%20%3E%20(model)%20zone_authenticated_origin_pull%20%3E%20(schema)>)
class ZoneCertificateListResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.zone_certificates%20%3E%20(model)%20zone_certificate_list_response%20%3E%20(schema)>)
class ZoneCertificateGetResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.zone_certificates%20%3E%20(model)%20zone_certificate_get_response%20%3E%20(schema)>)
class ZoneCertificateCreateResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.zone_certificates%20%3E%20(model)%20zone_certificate_create_response%20%3E%20(schema)>)
class ZoneCertificateDeleteResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The zone’s leaf certificate. Link to this property enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property private\_key: Optional\[str] The zone’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.zone_certificates%20%3E%20(model)%20zone_certificate_delete_response%20%3E%20(schema)>) #### Origin TLS Client AuthHostnames ##### [Get the Hostname Status for Client Authentication](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostnames/methods/get) 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](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostnames/methods/update) 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] Certificate identifier tag. maxLength36 Link to this property
cert\_status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property cert\_updated\_at: Optional\[datetime] The time when the certificate was updated. formatdate-time Link to this property cert\_uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property certificate: Optional\[str] The hostname certificate. Link to this property created\_at: Optional\[datetime] The time when the certificate was created. formatdate-time Link to this property enabled: Optional\[bool] Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property hostname: Optional\[str] The hostname on the origin for which the client certificate uploaded will be used. maxLength255 Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property updated\_at: Optional\[datetime] The time when the certificate was updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostnames%20%3E%20(model)%20authenticated_origin_pull%20%3E%20(schema)>)
class HostnameUpdateResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property cert\_id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property enabled: Optional\[bool] Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association. Link to this property hostname: Optional\[str] The hostname on the origin for which the client certificate uploaded will be used. maxLength255 Link to this property private\_key: Optional\[str] The hostname certificate’s private key. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostnames%20%3E%20(model)%20hostname_update_response%20%3E%20(schema)>) #### Origin TLS Client AuthHostname Certificates ##### [List Certificates](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostname_certificates/methods/list) 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](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostname_certificates/methods/get) 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](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostname_certificates/methods/create) origin\_tls\_client\_auth.hostname\_certificates.create(HostnameCertificateCreateParams\*\*kwargs) -> [HostnameCertificateCreateResponse]() POST/zones/{zone\_id}/origin\_tls\_client\_auth/hostnames/certificates ##### [Delete Hostname Client Certificate](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/hostname_certificates/methods/delete) 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] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostname_certificates%20%3E%20(model)%20certificate%20%3E%20(schema)>)
class HostnameCertificateListResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostname_certificates%20%3E%20(model)%20hostname_certificate_list_response%20%3E%20(schema)>)
class HostnameCertificateGetResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostname_certificates%20%3E%20(model)%20hostname_certificate_get_response%20%3E%20(schema)>)
class HostnameCertificateCreateResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostname_certificates%20%3E%20(model)%20hostname_certificate_create_response%20%3E%20(schema)>)
class HostnameCertificateDeleteResponse: … id: Optional\[str] Certificate identifier tag. maxLength36 Link to this property certificate: Optional\[str] The hostname certificate. Link to this property expires\_on: Optional\[datetime] The date when the certificate expires. formatdate-time Link to this property issuer: Optional\[str] The certificate authority that issued the certificate. Link to this property serial\_number: Optional\[str] The serial number on the uploaded certificate. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 4 more]] Status of the certificate or the association. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deleted" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property uploaded\_on: Optional\[datetime] The time when the certificate was uploaded. formatdate-time Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.hostname_certificates%20%3E%20(model)%20hostname_certificate_delete_response%20%3E%20(schema)>) #### Origin TLS Client AuthSettings ##### [Get Enablement Setting for Zone](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/settings/methods/get) origin\_tls\_client\_auth.settings.get(SettingGetParams\*\*kwargs) -> [SettingGetResponse]() GET/zones/{zone\_id}/origin\_tls\_client\_auth/settings ##### [Set Enablement for Zone](https://developers.cloudflare.com/api/python/resources/origin_tls_client_auth/subresources/settings/methods/update) 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. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.settings%20%3E%20(model)%20setting_get_response%20%3E%20(schema)>)
class SettingUpdateResponse: … enabled: Optional\[bool] Indicates whether zone-level authenticated origin pulls is enabled. Link to this property
[Link to this property](<#(resource)%20origin_tls_client_auth.settings%20%3E%20(model)%20setting_update_response%20%3E%20(schema)>)