SSL Verification Details

Get SSL Verification Info for a Zone.

/zones/{zone_identifier}/ssl/verification

get

SSL Verification

ssl-verification-ssl-verification-details

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "#ssl:read"
  ]
}

Debug "parameters"

[
  {
    "in": "path",
    "name": "zone_identifier",
    "required": true,
    "schema": {
      "description": "Identifier",
      "example": "023e105f4ecef8ad9ca31a8372d0c353",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "retry",
    "schema": {
      "description": "Immediately retry SSL Verification.",
      "enum": [
        true
      ],
      "example": true
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "properties": {
                "result": {
                  "items": {
                    "properties": {
                      "brand_check": {
                        "description": "Certificate Authority is manually reviewing the order.",
                        "example": false,
                        "type": "boolean"
                      },
                      "cert_pack_uuid": {
                        "description": "Certificate Pack UUID.",
                        "example": "a77f8bd7-3b47-46b4-a6f1-75cf98109948",
                        "type": "string"
                      },
                      "certificate_status": {
                        "description": "Current status of certificate.",
                        "enum": [
                          "initializing",
                          "authorizing",
                          "active",
                          "expired",
                          "issuing",
                          "timing_out",
                          "pending_deployment"
                        ],
                        "example": "active",
                        "type": "string"
                      },
                      "signature": {
                        "description": "Certificate's signature algorithm.",
                        "enum": [
                          "ECDSAWithSHA256",
                          "SHA1WithRSA",
                          "SHA256WithRSA"
                        ],
                        "type": "string"
                      },
                      "validation_method": {
                        "description": "Validation method in use for a certificate pack order.",
                        "enum": [
                          "http",
                          "cname",
                          "txt"
                        ],
                        "example": "txt",
                        "type": "string"
                      },
                      "verification_info": {
                        "description": "Certificate's required verification information.",
                        "properties": {
                          "record_name": {
                            "description": "Name of CNAME record.",
                            "enum": [
                              "record_name",
                              "http_url",
                              "cname",
                              "txt_name"
                            ],
                            "example": "b3b90cfedd89a3e487d3e383c56c4267.example.com",
                            "format": "hostname",
                            "type": "string"
                          },
                          "record_target": {
                            "description": "Target of CNAME record.",
                            "enum": [
                              "record_value",
                              "http_body",
                              "cname_target",
                              "txt_value"
                            ],
                            "example": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com",
                            "format": "hostname",
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "verification_status": {
                        "description": "Status of the required verification information, omitted if verification status is unknown.",
                        "example": true,
                        "type": "boolean"
                      },
                      "verification_type": {
                        "description": "Method of verification.",
                        "enum": [
                          "cname",
                          "meta tag"
                        ],
                        "example": "cname",
                        "type": "string"
                      }
                    },
                    "required": [
                      "certificate_status"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              }
            }
          ]
        }
      }
    },
    "description": "SSL Verification Details response"
  },
  "4XX": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "properties": {
                    "result": {
                      "items": {
                        "properties": {
                          "brand_check": {
                            "description": "Certificate Authority is manually reviewing the order.",
                            "example": false,
                            "type": "boolean"
                          },
                          "cert_pack_uuid": {
                            "description": "Certificate Pack UUID.",
                            "example": "a77f8bd7-3b47-46b4-a6f1-75cf98109948",
                            "type": "string"
                          },
                          "certificate_status": {
                            "description": "Current status of certificate.",
                            "enum": [
                              "initializing",
                              "authorizing",
                              "active",
                              "expired",
                              "issuing",
                              "timing_out",
                              "pending_deployment"
                            ],
                            "example": "active",
                            "type": "string"
                          },
                          "signature": {
                            "description": "Certificate's signature algorithm.",
                            "enum": [
                              "ECDSAWithSHA256",
                              "SHA1WithRSA",
                              "SHA256WithRSA"
                            ],
                            "type": "string"
                          },
                          "validation_method": {
                            "description": "Validation method in use for a certificate pack order.",
                            "enum": [
                              "http",
                              "cname",
                              "txt"
                            ],
                            "example": "txt",
                            "type": "string"
                          },
                          "verification_info": {
                            "description": "Certificate's required verification information.",
                            "properties": {
                              "record_name": {
                                "description": "Name of CNAME record.",
                                "enum": [
                                  "record_name",
                                  "http_url",
                                  "cname",
                                  "txt_name"
                                ],
                                "example": "b3b90cfedd89a3e487d3e383c56c4267.example.com",
                                "format": "hostname",
                                "type": "string"
                              },
                              "record_target": {
                                "description": "Target of CNAME record.",
                                "enum": [
                                  "record_value",
                                  "http_body",
                                  "cname_target",
                                  "txt_value"
                                ],
                                "example": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com",
                                "format": "hostname",
                                "type": "string"
                              }
                            },
                            "type": "object"
                          },
                          "verification_status": {
                            "description": "Status of the required verification information, omitted if verification status is unknown.",
                            "example": true,
                            "type": "boolean"
                          },
                          "verification_type": {
                            "description": "Method of verification.",
                            "enum": [
                              "cname",
                              "meta tag"
                            ],
                            "example": "cname",
                            "type": "string"
                          }
                        },
                        "required": [
                          "certificate_status"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  }
                }
              ]
            },
            {
              "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": "SSL Verification Details response failure"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]