Skip to content
Cloudflare API
Start here
API Reference
SSL

Certificate Packs

List Certificate Packs
client.ssl.certificatePacks.list(CertificatePackListParams { zone_id, deploy, page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<CertificatePackListResponse { id, certificates, hosts, 10 more } >
GET/zones/{zone_id}/ssl/certificate_packs
Get Certificate Pack
client.ssl.certificatePacks.get(stringcertificatePackId, CertificatePackGetParams { zone_id } params, RequestOptionsoptions?): CertificatePackGetResponse { id, certificates, hosts, 10 more }
GET/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}
Order Advanced Certificate Manager Certificate Pack
client.ssl.certificatePacks.create(CertificatePackCreateParams { zone_id, certificate_authority, hosts, 4 more } params, RequestOptionsoptions?): CertificatePackCreateResponse { id, certificates, hosts, 10 more }
POST/zones/{zone_id}/ssl/certificate_packs/order
Restart Validation or Update Advanced Certificate Manager Certificate Pack
client.ssl.certificatePacks.edit(stringcertificatePackId, CertificatePackEditParams { zone_id, cloudflare_branding } params, RequestOptionsoptions?): CertificatePackEditResponse { id, certificates, hosts, 10 more }
PATCH/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}
Delete Advanced Certificate Manager Certificate Pack
client.ssl.certificatePacks.delete(stringcertificatePackId, CertificatePackDeleteParams { zone_id } params, RequestOptionsoptions?): CertificatePackDeleteResponse { id }
DELETE/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}
ModelsExpand Collapse
Host = string
RequestValidity = 7 | 30 | 90 | 4 more

The number of days for which the certificate should be valid.

One of the following:
7
30
90
365
730
1095
5475
Status = "initializing" | "pending_validation" | "deleted" | 18 more

Status of certificate pack.

One of the following:
"initializing"
"pending_validation"
"deleted"
"pending_issuance"
"pending_deployment"
"pending_deletion"
"pending_expiration"
"expired"
"active"
"initializing_timed_out"
"validation_timed_out"
"issuance_timed_out"
"deployment_timed_out"
"deletion_timed_out"
"pending_cleanup"
"staging_deployment"
"staging_active"
"deactivating"
"inactive"
"backup_issued"
"holding_deployment"
ValidationMethod = "http" | "cname" | "txt"

Validation method in use for a certificate pack order.

One of the following:
"http"
"cname"
"txt"
CertificatePackListResponse { id, certificates, hosts, 10 more }

A certificate pack with all its properties.

id: string

Identifier.

maxLength32
certificates: Array<Certificate>

Array of certificates in this pack.

id: string

Certificate identifier.

hosts: Array<string>

Hostnames covered by this certificate.

status: string

Certificate status.

bundle_method?: string

Certificate bundle method.

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.

label?: "us" | "eu" | "highest_security"
One of the following:
"us"
"eu"
"highest_security"
issuer?: string

The certificate authority that issued the certificate.

modified_on?: string

When the certificate was last modified.

formatdate-time
priority?: number

The order/priority in which the certificate will be used.

signature?: string

The type of hash used for the certificate.

uploaded_on?: string

When the certificate was uploaded to Cloudflare.

formatdate-time
zone_id?: string

Identifier.

maxLength32
hosts: Array<Host>

Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

status: Status

Status of certificate pack.

type: "mh_custom" | "managed_hostname" | "sni_custom" | 5 more

Type of certificate pack.

One of the following:
"mh_custom"
"managed_hostname"
"sni_custom"
"universal"
"advanced"
"total_tls"
"keyless"
"legacy_custom"
certificate_authority?: "google" | "lets_encrypt" | "ssl_com"

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
cloudflare_branding?: boolean

Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

primary_certificate?: string

Identifier of the primary certificate in a pack.

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_method?: "txt" | "http" | "email"

Validation Method selected for the order.

One of the following:
"txt"
"http"
"email"
validation_records?: Array<ValidationRecord>

Certificates' validation records.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

validity_days?: 14 | 30 | 90 | 365

Validity Days selected for the order.

One of the following:
14
30
90
365
CertificatePackGetResponse { id, certificates, hosts, 10 more }

A certificate pack with all its properties.

id: string

Identifier.

maxLength32
certificates: Array<Certificate>

Array of certificates in this pack.

id: string

Certificate identifier.

hosts: Array<string>

Hostnames covered by this certificate.

status: string

Certificate status.

bundle_method?: string

Certificate bundle method.

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.

label?: "us" | "eu" | "highest_security"
One of the following:
"us"
"eu"
"highest_security"
issuer?: string

The certificate authority that issued the certificate.

modified_on?: string

When the certificate was last modified.

formatdate-time
priority?: number

The order/priority in which the certificate will be used.

signature?: string

The type of hash used for the certificate.

uploaded_on?: string

When the certificate was uploaded to Cloudflare.

formatdate-time
zone_id?: string

Identifier.

maxLength32
hosts: Array<Host>

Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

status: Status

Status of certificate pack.

type: "mh_custom" | "managed_hostname" | "sni_custom" | 5 more

Type of certificate pack.

One of the following:
"mh_custom"
"managed_hostname"
"sni_custom"
"universal"
"advanced"
"total_tls"
"keyless"
"legacy_custom"
certificate_authority?: "google" | "lets_encrypt" | "ssl_com"

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
cloudflare_branding?: boolean

Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

primary_certificate?: string

Identifier of the primary certificate in a pack.

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_method?: "txt" | "http" | "email"

Validation Method selected for the order.

One of the following:
"txt"
"http"
"email"
validation_records?: Array<ValidationRecord>

Certificates' validation records.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

validity_days?: 14 | 30 | 90 | 365

Validity Days selected for the order.

One of the following:
14
30
90
365
CertificatePackCreateResponse { id, certificates, hosts, 10 more }

A certificate pack with all its properties.

id: string

Identifier.

maxLength32
certificates: Array<Certificate>

Array of certificates in this pack.

id: string

Certificate identifier.

hosts: Array<string>

Hostnames covered by this certificate.

status: string

Certificate status.

bundle_method?: string

Certificate bundle method.

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.

label?: "us" | "eu" | "highest_security"
One of the following:
"us"
"eu"
"highest_security"
issuer?: string

The certificate authority that issued the certificate.

modified_on?: string

When the certificate was last modified.

formatdate-time
priority?: number

The order/priority in which the certificate will be used.

signature?: string

The type of hash used for the certificate.

uploaded_on?: string

When the certificate was uploaded to Cloudflare.

formatdate-time
zone_id?: string

Identifier.

maxLength32
hosts: Array<Host>

Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

status: Status

Status of certificate pack.

type: "mh_custom" | "managed_hostname" | "sni_custom" | 5 more

Type of certificate pack.

One of the following:
"mh_custom"
"managed_hostname"
"sni_custom"
"universal"
"advanced"
"total_tls"
"keyless"
"legacy_custom"
certificate_authority?: "google" | "lets_encrypt" | "ssl_com"

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
cloudflare_branding?: boolean

Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

primary_certificate?: string

Identifier of the primary certificate in a pack.

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_method?: "txt" | "http" | "email"

Validation Method selected for the order.

One of the following:
"txt"
"http"
"email"
validation_records?: Array<ValidationRecord>

Certificates' validation records.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

validity_days?: 14 | 30 | 90 | 365

Validity Days selected for the order.

One of the following:
14
30
90
365
CertificatePackEditResponse { id, certificates, hosts, 10 more }

A certificate pack with all its properties.

id: string

Identifier.

maxLength32
certificates: Array<Certificate>

Array of certificates in this pack.

id: string

Certificate identifier.

hosts: Array<string>

Hostnames covered by this certificate.

status: string

Certificate status.

bundle_method?: string

Certificate bundle method.

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.

label?: "us" | "eu" | "highest_security"
One of the following:
"us"
"eu"
"highest_security"
issuer?: string

The certificate authority that issued the certificate.

modified_on?: string

When the certificate was last modified.

formatdate-time
priority?: number

The order/priority in which the certificate will be used.

signature?: string

The type of hash used for the certificate.

uploaded_on?: string

When the certificate was uploaded to Cloudflare.

formatdate-time
zone_id?: string

Identifier.

maxLength32
hosts: Array<Host>

Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.

status: Status

Status of certificate pack.

type: "mh_custom" | "managed_hostname" | "sni_custom" | 5 more

Type of certificate pack.

One of the following:
"mh_custom"
"managed_hostname"
"sni_custom"
"universal"
"advanced"
"total_tls"
"keyless"
"legacy_custom"
certificate_authority?: "google" | "lets_encrypt" | "ssl_com"

Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
cloudflare_branding?: boolean

Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

primary_certificate?: string

Identifier of the primary certificate in a pack.

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_method?: "txt" | "http" | "email"

Validation Method selected for the order.

One of the following:
"txt"
"http"
"email"
validation_records?: Array<ValidationRecord>

Certificates' validation records.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

validity_days?: 14 | 30 | 90 | 365

Validity Days selected for the order.

One of the following:
14
30
90
365
CertificatePackDeleteResponse { id }
id?: string

Identifier.

maxLength32

Certificate PacksQuota

Get Certificate Pack Quotas
client.ssl.certificatePacks.quota.get(QuotaGetParams { zone_id } params, RequestOptionsoptions?): QuotaGetResponse { advanced }
GET/zones/{zone_id}/ssl/certificate_packs/quota
ModelsExpand Collapse
QuotaGetResponse { advanced }
advanced?: Advanced { allocated, used }
allocated?: number

Quantity Allocated.

used?: number

Quantity Used.