Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Get

Used to get information about a certificate

For backwards compatibility this call is also available on the url /v2/customers/customer/certificates/certificateId
  • GETMethod
  • /v2/ssl/certificates/certificateIdURL
URL fields
Name Type Description Restrictions
Certificate ID Integer The ID of the certificate
Request parameters
Name Type Required / Optional Description Restrictions
Fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Retrieved certificate information successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
Certificate ID Integer Required The ID of the certificate
Process ID Integer Required The ID of the request process
Product String Required The certificate product
Validation type Enum Required The type of validation used for the certificate

Possible values:

  • DOMAIN_VALIDATION: Domain validation
  • ORGANIZATION_VALIDATION: Organization validation
  • EXTENDED_VALIDATION: Extended validation
Certificate type Enum Required The type of certificate

Possible values:

  • SINGLE_DOMAIN: Single domain
  • MULTI_DOMAIN: Multi domain
  • WILDCARD: Wildcard
Domain Name String Required The domain name
Organization String Optional The organization used with the certificate
Department String Optional The department used with the certificate
Address lines List <String> Optional The address lines used with the certificate
City String Optional The city used with the certificate
State String Optional The state used with the certificate
Postal code String Optional The postal code used with the certificate
Country code String Optional The country code used with the certificate
COC String Optional Chamber Of Commerce identifier, see requiredFields/optionalFields in ssl product metadata for usage
Provider certificate ID String Optional The certificate ID of the provider
Start date Timestamp Required The start date of the certificate
Expiry date Timestamp Required The expiry date of the certificate
Expiry date Timestamp Optional For subscription based certificates, the end date of the subscription
SAN List <String> Optional List of SAN domains
Status Enum Required The status of the certificate

Possible values:

  • ACTIVE: Active
  • EXPIRED: Expired
  • REVOKED: Revoked
  • REISSUED: Reissued
  • RENEWED: Renewed
Public key algorithm Enum Optional The algorithm used for the public key

Possible values:

  • RSA
  • ECDSA
Public key size Integer Optional The key size in bits of the public key
CSR String Optional The Certificate Signing Request
Certificate String Optional The Certificate
Fingerprint String Optional The SHA-256 fingerprint of the certificate

Failed requests

Generic errors can be expected.

URL fields
The ID of the certificate
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/ssl/certificates/certificateId

Response