Skip to content
Cloudflare API
Start here
API Reference

Custom Certificates

List SSL Configurations
client.customCertificates.list(CustomCertificateListParams { zone_id, match, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<CustomCertificate { id, zone_id, bundle_method, 12 more } >
GET/zones/{zone_id}/custom_certificates
SSL Configuration Details
client.customCertificates.get(stringcustomCertificateId, CustomCertificateGetParams { zone_id } params, RequestOptionsoptions?): CustomCertificate { id, zone_id, bundle_method, 12 more }
GET/zones/{zone_id}/custom_certificates/{custom_certificate_id}
Create SSL Configuration
client.customCertificates.create(CustomCertificateCreateParams { zone_id, certificate, private_key, 6 more } params, RequestOptionsoptions?): CustomCertificate { id, zone_id, bundle_method, 12 more }
POST/zones/{zone_id}/custom_certificates
Edit SSL Configuration
client.customCertificates.edit(stringcustomCertificateId, CustomCertificateEditParams { zone_id, bundle_method, certificate, 5 more } params, RequestOptionsoptions?): CustomCertificate { id, zone_id, bundle_method, 12 more }
PATCH/zones/{zone_id}/custom_certificates/{custom_certificate_id}
Delete SSL Configuration
client.customCertificates.delete(stringcustomCertificateId, CustomCertificateDeleteParams { zone_id } params, RequestOptionsoptions?): CustomCertificateDeleteResponse { id }
DELETE/zones/{zone_id}/custom_certificates/{custom_certificate_id}
ModelsExpand Collapse
CustomCertificate { id, zone_id, bundle_method, 12 more }
id: string

Identifier.

maxLength32
zone_id: string

Identifier.

maxLength32
bundle_method?: BundleMethod

A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

expires_on?: string

When the certificate from the authority expires.

formatdate-time
geo_restrictions?: GeoRestrictions { label }

Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.

hosts?: Array<string>
issuer?: string

The certificate authority that issued the certificate.

keyless_server?: KeylessCertificate { id, created_on, enabled, 7 more }
modified_on?: string

When the certificate was last modified.

formatdate-time
policy_restrictions?: string

The policy restrictions returned by the API. This field is returned in responses when a policy has been set. The API accepts the "policy" field in requests but returns this field as "policy_restrictions" in responses.

Specifies the region(s) where your private key can be held locally for optimal TLS performance. Format is a boolean expression, for example: "(country: US) or (region: EU)"

priority?: number

The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.

signature?: string

The type of hash used for the certificate.

status?: "active" | "expired" | "deleted" | 2 more

Status of the zone's custom SSL.

One of the following:
"active"
"expired"
"deleted"
"pending"
"initializing"
uploaded_on?: string

When the certificate was uploaded to Cloudflare.

formatdate-time
GeoRestrictions { label }

Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.

label?: "us" | "eu" | "highest_security"
One of the following:
"us"
"eu"
"highest_security"
Status = "active" | "pending_reactivation" | "pending_revocation" | "revoked"

Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions

One of the following:
"active"
"pending_reactivation"
"pending_revocation"
"revoked"
CustomCertificateDeleteResponse { id }
id?: string

Identifier.

maxLength32

Custom CertificatesPrioritize

Re-prioritize SSL Certificates
client.customCertificates.prioritize.update(PrioritizeUpdateParams { zone_id, certificates } params, RequestOptionsoptions?): SinglePage<CustomCertificate { id, zone_id, bundle_method, 12 more } >
PUT/zones/{zone_id}/custom_certificates/prioritize