Retrieve an Existing Certificate

v1.0.0

To show information about an existing certificate, send a GET request to /v2/certificates/$CERTIFICATE_ID.

Input

{
  "type": "object",
  "properties": {
    "certificate_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "certificate_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "certificate": {
      "type": "object",
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "A time value given in ISO8601 combined date and time format that represents when the certificate was created."
        },
        "dns_names": {
          "type": "array",
          "description": "An array of fully qualified domain names (FQDNs) for which the certificate was issued.",
          "items": {
            "type": "string"
          }
        },
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "A unique ID that can be used to identify and reference a certificate."
        },
        "name": {
          "type": "string",
          "description": "A unique human-readable name referring to a certificate."
        },
        "not_after": {
          "type": "string",
          "format": "date-time",
          "description": "A time value given in ISO8601 combined date and time format that represents the certificate's expiration date."
        },
        "sha1_fingerprint": {
          "type": "string",
          "description": "A unique identifier generated from the SHA-1 fingerprint of the certificate."
        },
        "state": {
          "type": "string",
          "description": "A string representing the current state of the certificate. It may be `pending`, `verified`, or `error`.",
          "enum": [
            "pending",
            "verified",
            "error"
          ]
        },
        "type": {
          "type": "string",
          "description": "A string representing the type of the certificate. The value will be `custom` for a user-uploaded certificate or `lets_encrypt` for one automatically generated with Let's Encrypt.",
          "enum": [
            "custom",
            "lets_encrypt"
          ]
        }
      }
    }
  }
}