tls-certificates-and-hostnames_ssl

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tls-certificates-and-hostnames_ssl",
  "title": "tls-certificates-and-hostnames_ssl",
  "description": "SSL properties for the custom hostname.",
  "oneOf": [
    {
      "properties": {
        "bundle_method": {
          "default": "ubiquitous",
          "description": "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.",
          "enum": [
            "ubiquitous",
            "optimal",
            "force"
          ],
          "example": "ubiquitous",
          "type": "string"
        },
        "certificate_authority": {
          "$ref": "#/components/schemas/tls-certificates-and-hostnames_certificate_authority"
        },
        "custom_certificate": {
          "description": "If a custom uploaded certificate is used.",
          "example": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n",
          "type": "string"
        },
        "custom_csr_id": {
          "description": "The identifier for the Custom CSR that was used.",
          "example": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
          "type": "string"
        },
        "custom_key": {
          "description": "The key for a custom uploaded certificate.",
          "example": "REDACTED_PRIVATE_KEY_EXAMPLE\n",
          "type": "string"
        },
        "expires_on": {
          "description": "The time the custom certificate expires on.",
          "example": "2021-02-06T18:11:23.531995Z",
          "format": "date-time",
          "type": "string"
        },
        "hosts": {
          "description": "A list of Hostnames on a custom uploaded certificate.",
          "example": [
            "app.example.com",
            "*.app.example.com"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "id": {
          "description": "Custom hostname SSL identifier tag.",
          "example": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
          "maxLength": 36,
          "minLength": 36,
          "type": "string"
        },
        "issuer": {
          "description": "The issuer on a custom uploaded certificate.",
          "example": "DigiCertInc",
          "type": "string"
        },
        "method": {
          "description": "Domain control validation (DCV) method used for this hostname.",
          "enum": [
            "http",
            "txt",
            "email"
          ],
          "example": "txt"
        },
        "serial_number": {
          "description": "The serial number on a custom uploaded certificate.",
          "example": "6743787633689793699141714808227354901",
          "type": "string"
        },
        "settings": {
          "$ref": "#/components/schemas/tls-certificates-and-hostnames_sslsettings"
        },
        "signature": {
          "description": "The signature on a custom uploaded certificate.",
          "example": "SHA256WithRSA",
          "type": "string"
        },
        "status": {
          "description": "Status of the hostname's SSL certificates.",
          "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": "pending_validation",
          "readOnly": true
        },
        "type": {
          "description": "Level of validation to be used for this hostname. Domain validation (dv) must be used.",
          "enum": [
            "dv"
          ],
          "example": "dv"
        },
        "uploaded_on": {
          "description": "The time the custom certificate was uploaded.",
          "example": "2020-02-06T18:11:23.531995Z",
          "format": "date-time",
          "type": "string"
        },
        "validation_errors": {
          "description": "Domain validation errors that have been received by the certificate authority (CA).",
          "items": {
            "properties": {
              "message": {
                "description": "A domain validation error.",
                "example": "SERVFAIL looking up CAA for app.example.com",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "validation_records": {
          "items": {
            "$ref": "#/components/schemas/tls-certificates-and-hostnames_validation_record"
          },
          "type": "array"
        },
        "wildcard": {
          "description": "Indicates whether the certificate covers a wildcard.",
          "example": false,
          "type": "boolean"
        }
      },
      "type": "object"
    }
  ],
  "type": "object"
}