Order Advanced Certificate Manager Certificate Pack

POST /zones/{zone_id}/ssl/certificate_packs/order

Copy endpoint

https://api.cloudflare.com/client/v4

For a given zone, order an advanced certificate pack.

Parameters

path Path Parameters

Name	Type
`zone_id` required	type TlsCertificatesAndHostnamesIdentifier = string

Request Body

application/json required

{
certificate_authority:

TlsCertificatesAndHostnamesSchemasCertificateAuthority

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

type TlsCertificatesAndHostnamesSchemasCertificateAuthority = "google" | "lets_encrypt" | "ssl_com"

;
cloudflare_branding?:

TlsCertificatesAndHostnamesCloudflareBranding

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.

type TlsCertificatesAndHostnamesCloudflareBranding = boolean

;
hosts:

TlsCertificatesAndHostnamesSchemasHosts

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.

type TlsCertificatesAndHostnamesSchemasHosts = string[]

;
type:

TlsCertificatesAndHostnamesAdvancedType

Type of certificate pack.

type TlsCertificatesAndHostnamesAdvancedType = "advanced"

;
validation_method:

TlsCertificatesAndHostnamesValidationMethod

Validation Method selected for the order.

type TlsCertificatesAndHostnamesValidationMethod = "txt" | "http" | "email"

;
validity_days:

TlsCertificatesAndHostnamesValidityDays

Validity Days selected for the order.

type TlsCertificatesAndHostnamesValidityDays = 14 | 30 | 90 | 365

;
}

Responses

200 application/json

Order Advanced Certificate Manager Certificate Pack response

type TlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle = type TlsCertificatesAndHostnamesApiResponseSingle = interface TlsCertificatesAndHostnamesApiResponseCommon {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?: {
certificate_authority?:

TlsCertificatesAndHostnamesSchemasCertificateAuthority

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

type TlsCertificatesAndHostnamesSchemasCertificateAuthority = "google" | "lets_encrypt" | "ssl_com"

;
cloudflare_branding?:

TlsCertificatesAndHostnamesCloudflareBranding

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.

type TlsCertificatesAndHostnamesCloudflareBranding = boolean

;
hosts?:

TlsCertificatesAndHostnamesSchemasHosts

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.

type TlsCertificatesAndHostnamesSchemasHosts = string[]

;
id?:

TlsCertificatesAndHostnamesIdentifier

Identifier.

type TlsCertificatesAndHostnamesIdentifier = string

;
status?:

TlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus

Status of certificate pack.

;
type?:

TlsCertificatesAndHostnamesSchemasType

Type of certificate pack.

;
validation_errors?: { message?: string; }[];
validation_method?:

TlsCertificatesAndHostnamesValidationMethod

Validation Method selected for the order.

type TlsCertificatesAndHostnamesValidationMethod = "txt" | "http" | "email"

;
validation_records?:

TlsCertificatesAndHostnamesValidationRecord

Certificate's required validation record.

interface TlsCertificatesAndHostnamesValidationRecord {
emails?: string[];
http_body?: string;
http_url?: string;
txt_name?: string;
txt_value?: string;
}

[];
validity_days?:

TlsCertificatesAndHostnamesValidityDays

Validity Days selected for the order.

type TlsCertificatesAndHostnamesValidityDays = 14 | 30 | 90 | 365

;
}; }

Client Errors

4XX application/json

Order Advanced Certificate Manager Certificate Pack response failure

type TlsCertificatesAndHostnamesAdvancedCertificatePackResponseSingle = type TlsCertificatesAndHostnamesApiResponseSingle = interface TlsCertificatesAndHostnamesApiResponseCommon {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
success: true;
} & {} & { result?: {
certificate_authority?:

TlsCertificatesAndHostnamesSchemasCertificateAuthority

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

type TlsCertificatesAndHostnamesSchemasCertificateAuthority = "google" | "lets_encrypt" | "ssl_com"

;
cloudflare_branding?:

TlsCertificatesAndHostnamesCloudflareBranding

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.

type TlsCertificatesAndHostnamesCloudflareBranding = boolean

;
hosts?:

TlsCertificatesAndHostnamesSchemasHosts

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.

type TlsCertificatesAndHostnamesSchemasHosts = string[]

;
id?:

TlsCertificatesAndHostnamesIdentifier

Identifier.

type TlsCertificatesAndHostnamesIdentifier = string

;
status?:

TlsCertificatesAndHostnamesCertificatePacksComponentsSchemasStatus

Status of certificate pack.

;
type?:

TlsCertificatesAndHostnamesSchemasType

Type of certificate pack.

;
validation_errors?: { message?: string; }[];
validation_method?:

TlsCertificatesAndHostnamesValidationMethod

Validation Method selected for the order.

type TlsCertificatesAndHostnamesValidationMethod = "txt" | "http" | "email"

;
validation_records?:

TlsCertificatesAndHostnamesValidationRecord

Certificate's required validation record.

interface TlsCertificatesAndHostnamesValidationRecord {
emails?: string[];
http_body?: string;
http_url?: string;
txt_name?: string;
txt_value?: string;
}

[];
validity_days?:

TlsCertificatesAndHostnamesValidityDays

Validity Days selected for the order.

type TlsCertificatesAndHostnamesValidityDays = 14 | 30 | 90 | 365

;
}; } & interface TlsCertificatesAndHostnamesApiResponseCommonFailure {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}