For a given zone, order an advanced certificate pack.
/zones/{zone_identifier}/ssl/certificate_packs/order
post
Certificate Packs
certificate-packs-order-advanced-certificate-manager-certificate-pack
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#ssl:read",
"#ssl:edit"
]
}[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"certificate_authority": {
"description": "Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)",
"enum": [
"google",
"lets_encrypt"
],
"example": "lets_encrypt",
"type": "string"
},
"cloudflare_branding": {
"description": "Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.",
"example": false,
"type": "boolean"
},
"hosts": {
"description": "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.",
"example": [
"example.com",
"*.example.com",
"www.example.com"
],
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type of certificate pack.",
"enum": [
"advanced"
],
"example": "advanced",
"type": "string"
},
"validation_method": {
"description": "Validation Method selected for the order.",
"enum": [
"txt",
"http",
"email"
],
"example": "txt",
"type": "string"
},
"validity_days": {
"description": "Validity Days selected for the order.",
"enum": [
14,
30,
90,
365
],
"type": "integer"
}
},
"required": [
"type",
"hosts",
"validation_method",
"validity_days",
"certificate_authority"
],
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"certificate_authority": {
"description": "Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)",
"enum": [
"google",
"lets_encrypt"
],
"example": "lets_encrypt",
"type": "string"
},
"cloudflare_branding": {
"description": "Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.",
"example": false,
"type": "boolean"
},
"hosts": {
"description": "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.",
"example": [
"example.com",
"*.example.com",
"www.example.com"
],
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"status": {
"description": "Status of certificate pack.",
"enum": [
"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"
],
"example": "initializing",
"type": "string"
},
"type": {
"description": "Type of certificate pack.",
"enum": [
"advanced"
],
"example": "advanced",
"type": "string"
},
"validation_method": {
"description": "Validation Method selected for the order.",
"enum": [
"txt",
"http",
"email"
],
"example": "txt",
"type": "string"
},
"validity_days": {
"description": "Validity Days selected for the order.",
"enum": [
14,
30,
90,
365
],
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Order Advanced Certificate Manager Certificate Pack response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"certificate_authority": {
"description": "Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)",
"enum": [
"google",
"lets_encrypt"
],
"example": "lets_encrypt",
"type": "string"
},
"cloudflare_branding": {
"description": "Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.",
"example": false,
"type": "boolean"
},
"hosts": {
"description": "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.",
"example": [
"example.com",
"*.example.com",
"www.example.com"
],
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"status": {
"description": "Status of certificate pack.",
"enum": [
"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"
],
"example": "initializing",
"type": "string"
},
"type": {
"description": "Type of certificate pack.",
"enum": [
"advanced"
],
"example": "advanced",
"type": "string"
},
"validation_method": {
"description": "Validation Method selected for the order.",
"enum": [
"txt",
"http",
"email"
],
"example": "txt",
"type": "string"
},
"validity_days": {
"description": "Validity Days selected for the order.",
"enum": [
14,
30,
90,
365
],
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Order Advanced Certificate Manager Certificate Pack response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]