Origin TLS Client Auth

OriginTLSClientAuth

Methods

list(, ): <>
Deprecated
get/zones/{zone_id}/origin_tls_client_auth

Deprecated

Use zone_certificates.list for zone-level certificates. This method will be removed in a future major version.

List Certificates

get(, , ):
Deprecated
get/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Deprecated

Use zone_certificates.get for zone-level certificates. This method will be removed in a future major version.

Get Certificate Details

create(, ):
Deprecated
post/zones/{zone_id}/origin_tls_client_auth

Deprecated

Use zone_certificates.create for zone-level certificates. This method will be removed in a future major version.

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

delete(, , ):
Deprecated
delete/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Deprecated

Use zone_certificates.delete for zone-level certificates. This method will be removed in a future major version.

Delete Certificate

Origin TLS Client Auth

Hostname Certificates

OriginTLSClientAuth.HostnameCertificates

Methods

list(, ): <>
get/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates

List Certificates

get(, , ):
get/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}

Get the certificate by ID to be used for client authentication on a hostname.

create(, ):
post/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates

Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.

delete(, , ):
delete/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}

Delete Hostname Client Certificate

Domain types

Certificate{…}

OriginTLSClientAuth.Hostnames

Methods

get(, , ):
get/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}

Get the Hostname Status for Client Authentication

update(, ): <>
put/zones/{zone_id}/origin_tls_client_auth/hostnames

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter enabled to invalidate the association.

Domain types

AuthenticatedOriginPull{…}

OriginTLSClientAuth.Settings

Methods

get(, ):
get/zones/{zone_id}/origin_tls_client_auth/settings

Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

update(, ):
put/zones/{zone_id}/origin_tls_client_auth/settings

Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

Origin TLS Client Auth

Zone Certificates

OriginTLSClientAuth.ZoneCertificates

Methods

list(, ): <>
get/zones/{zone_id}/origin_tls_client_auth

List Certificates

get(, , ):
get/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Get Certificate Details

create(, ):
post/zones/{zone_id}/origin_tls_client_auth

Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

delete(, , ):
delete/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Delete Certificate

Domain types

ZoneAuthenticatedOriginPull{…}