Passa al contenuto principale

SslCertificatePaginatedListResponse

Successful response with a page of SslCertificate

errorintegerrequired

Always 0 in a successful response

Constant value: 0
messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

  • Array [
  • ssl_certificate_idintegerrequired
    purchase_idintegerrequired

    Id of the purchase of the certificate (GET /api/v3/purchases/{purchase_id})

    domain_namestring | nullnullablerequired
    cn_typestring | nullnullablerequired

    Type of the common name: NORMAL (a single name) or WILDCARD (a wildcard name, for the subdomains)

    validation_typestring | nullnullablerequired

    Validation level: DV (domain validation), OV (organization validation) or EV (extended validation)

    san_maxintegerrequired

    Maximum number of additional names (SAN, Subject Alternative Names) the certificate can include

    can_reissuebooleanrequired

    Whether the certificate includes reissues; GET /api/v3/ssl-certificates/{ssl_certificate_id}/can-reissue tells whether one can start now

    validation_methodstring | nullnullablerequired

    How the domain is validated: APPROVER_EMAIL (by email to approver_email) or DNS (with a CNAME record that we add to the zone of the domain, see csr_md5_hash)

    valid_todate-timenullablerequired

    Expiry of the certificate, at the end of the day (Italian time)

    csr_md5_hashstring | nullnullablerequired

    MD5 hash of the CSR for the DNS validation, in uppercase hexadecimal: the name of the CNAME record is _ followed by this hash; null without a DNS validation

    csr_sha256_hashstring | nullnullablerequired

    SHA-256 hash of the CSR for the DNS validation, in uppercase hexadecimal split in two by a dot: the destination of the CNAME record starts with it; null without a DNS validation

    certificate_statusstring | nullnullablerequired

    Status of the certificate at the certification authority, for example Issued, Expired, Rejected or Revoked

    approver_emailemailnullablerequired

    Address that receives the request to approve the validation of the domain, with the APPROVER_EMAIL method (see GET /api/v3/ssl-certificates/approver-emails)

    admin_first_namestring | nullnullablerequired

    First name of the administrative contact of the certificate

    admin_last_namestring | nullnullablerequired

    Last name of the administrative contact

    admin_organizationstring | nullnullablerequired

    Organization of the administrative contact

    admin_rolestring | nullnullablerequired

    Role of the administrative contact: Business Owner, Website Owner, President or Company Director

    admin_emailemailnullablerequired

    Email of the administrative contact

    admin_phone_ccstring | nullnullablerequired

    International dialling code of the phone of the administrative contact, for example 39

    admin_phone_numberstring | nullnullablerequired

    Phone number of the administrative contact, without the dialling code

    admin_addressstring | nullnullablerequired

    Address of the administrative contact

    admin_citystring | nullnullablerequired

    City of the administrative contact

    admin_statestring | nullnullablerequired

    State or province of the administrative contact

    admin_postal_codestring | nullnullablerequired

    Postal code of the administrative contact

    admin_countrystring | nullnullablerequired

    Country of the administrative contact, as ISO 3166-1 alpha-2 code (for example IT)

  • ]
  • meta objectrequired

    Pagination of the list

    totalintegerrequired

    Number of items in the whole list

    countintegerrequired

    Number of items in this page: 0 beyond the last page

    pagesintegerrequired

    Number of pages of the list

    pageintegerrequired

    Number of this page, starting from 1

    per_pageintegerrequired

    Maximum number of items in a page

    SslCertificatePaginatedListResponse
    {
    "error": 0,
    "message": "string",
    "data": [
    {
    "ssl_certificate_id": 0,
    "purchase_id": 0,
    "domain_name": "string",
    "cn_type": "string",
    "validation_type": "string",
    "san_max": 0,
    "can_reissue": true,
    "validation_method": "string",
    "valid_to": "2024-07-29T15:51:28.071Z",
    "csr_md5_hash": "string",
    "csr_sha256_hash": "string",
    "certificate_status": "string",
    "approver_email": "[email protected]",
    "admin_first_name": "string",
    "admin_last_name": "string",
    "admin_organization": "string",
    "admin_role": "string",
    "admin_email": "[email protected]",
    "admin_phone_cc": "string",
    "admin_phone_number": "string",
    "admin_address": "string",
    "admin_city": "string",
    "admin_state": "string",
    "admin_postal_code": "string",
    "admin_country": "string"
    }
    ],
    "meta": {
    "total": 0,
    "count": 0,
    "pages": 0,
    "page": 0,
    "per_page": 0
    }
    }