Skip to content
Start here

Custom Certificates

List SSL Configurations
client.CustomCertificates.List(ctx, params) (*V4PagePaginationArray[CustomCertificate], error)
GET/zones/{zone_id}/custom_certificates
SSL Configuration Details
client.CustomCertificates.Get(ctx, customCertificateID, query) (*CustomCertificate, error)
GET/zones/{zone_id}/custom_certificates/{custom_certificate_id}
Create SSL Configuration
client.CustomCertificates.New(ctx, params) (*CustomCertificate, error)
POST/zones/{zone_id}/custom_certificates
Edit SSL Configuration
client.CustomCertificates.Edit(ctx, customCertificateID, params) (*CustomCertificate, error)
PATCH/zones/{zone_id}/custom_certificates/{custom_certificate_id}
Delete SSL Configuration
client.CustomCertificates.Delete(ctx, customCertificateID, body) (*CustomCertificateDeleteResponse, error)
DELETE/zones/{zone_id}/custom_certificates/{custom_certificate_id}
ModelsExpand Collapse
type CustomCertificate struct{…}
ID string

Identifier.

maxLength32
ZoneID string

Identifier.

maxLength32
BundleMethod BundleMethodoptional

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.

CustomCsrID stringoptional

The identifier for the Custom CSR that was used.

ExpiresOn Timeoptional

When the certificate from the authority expires.

formatdate-time
GeoRestrictions GeoRestrictionsoptional

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 []stringoptional
Issuer stringoptional

The certificate authority that issued the certificate.

KeylessServer KeylessCertificateoptional
ModifiedOn Timeoptional

When the certificate was last modified.

formatdate-time
PolicyRestrictions stringoptional

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 float64optional

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 stringoptional

The type of hash used for the certificate.

Status CustomCertificateStatusoptional

Status of the zone's custom SSL.

One of the following:
const CustomCertificateStatusActive CustomCertificateStatus = "active"
const CustomCertificateStatusExpired CustomCertificateStatus = "expired"
const CustomCertificateStatusDeleted CustomCertificateStatus = "deleted"
const CustomCertificateStatusPending CustomCertificateStatus = "pending"
const CustomCertificateStatusInitializing CustomCertificateStatus = "initializing"
UploadedOn Timeoptional

When the certificate was uploaded to Cloudflare.

formatdate-time
type GeoRestrictions struct{…}

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 GeoRestrictionsLabeloptional
One of the following:
const GeoRestrictionsLabelUs GeoRestrictionsLabel = "us"
const GeoRestrictionsLabelEu GeoRestrictionsLabel = "eu"
const GeoRestrictionsLabelHighestSecurity GeoRestrictionsLabel = "highest_security"
type Status string

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

One of the following:
const StatusActive Status = "active"
const StatusPendingReactivation Status = "pending_reactivation"
const StatusPendingRevocation Status = "pending_revocation"
const StatusRevoked Status = "revoked"

Custom CertificatesPrioritize

Re-prioritize SSL Certificates
client.CustomCertificates.Prioritize.Update(ctx, params) (*SinglePage[CustomCertificate], error)
PUT/zones/{zone_id}/custom_certificates/prioritize