Skip to content
Start here

Certificates

List mTLS certificates
GET/{accounts_or_zones}/{account_or_zone_id}/access/certificates
Get an mTLS certificate
GET/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}
Add an mTLS certificate
POST/{accounts_or_zones}/{account_or_zone_id}/access/certificates
Update an mTLS certificate
PUT/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}
Delete an mTLS certificate
DELETE/{accounts_or_zones}/{account_or_zone_id}/access/certificates/{certificate_id}
ModelsExpand Collapse
AssociatedHostnames = string

A fully-qualified domain name (FQDN).

Certificate { id, associated_hostnames, expires_on, 2 more }
id: optional string

The ID of the application that will use this certificate.

associated_hostnames: optional array of AssociatedHostnames

The hostnames of the applications that will use this certificate.

expires_on: optional string
formatdate-time
fingerprint: optional string

The MD5 fingerprint of the certificate.

name: optional string

The name of the certificate.

CertificateDeleteResponse { id }
id: optional string

UUID.

maxLength36

CertificatesSettings

List all mTLS hostname settings
GET/{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings
Update an mTLS certificate's hostname settings
PUT/{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings
ModelsExpand Collapse
CertificateSettings { china_network, client_certificate_forwarding, hostname }
china_network: boolean

Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.

client_certificate_forwarding: boolean

Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.

hostname: string

The hostname that these settings apply to.