Skip to content
regfish Docs

tlsCertificateResponse

No description available in the specification.

Fields

Section titled “Fields”
Field Type Required Description
id tlsCertificateId yes Public TLS certificate ID
status tlsCertificateStatus yes (pending, issued, pending_cancellation, pending_revocation, pending_order_revocation, cancelled, order_cancelled, revoked, order_revoked, rejected, expired, unknown)
common_name string yes —
product string yes —
provider tlsCertificateProvider yes (digicert)
dns_names string[] yes —
action_required boolean yes —
pending_reason string yes —
pending_message string yes —
completion_url string yes Absolute URL where the remaining order details can be completed in the web interface. API clients can alternatively use /tls/certificate/{certificate_id}/complete.
organization_id string yes —
organization tlsCertificateOrganization no —
order_state string no —
revocation_scope tlsCertificateRevocationScope no (certificate, order)
revocation_pending_scope tlsCertificateRevocationScope no (certificate, order)
reissue_supported boolean no —
validity_days integer no Purchased base order validity in days as submitted for the order. On provider-linked renewals the effective issued certificate lifetime can be longer. Use valid_from and valid_until as the authoritative issued lifetime.
renewal_bonus_days integer no Confirmed additional validity days on top of validity_days, derived from the actually issued renewal certificate. This field is only present for renewal certificates once the effective issued lifetime can be determined.
serial_number string no —
valid_from string no —
valid_until string no Authoritative expiration timestamp of the currently issued certificate. On provider-linked renewals this can be later than validity_days would suggest if the provider adds remaining validity from the previous certificate.
contract_valid_from string no —
contract_valid_until string no —
last_status_check string no —
certificate_pem_available boolean yes —
order_cancellable boolean no —
order_cancellation_mode tlsCertificateOrderCancellationMode no (cancel_pending, revoke_issued)
order_cancellable_until string no —
validation tlsValidation no —
reissue tlsCertificateReissueResponse no —

Example

Section titled “Example”
{
  "id": "7K9QW3M2ZT8HJ",
  "status": "pending",
  "common_name": "string",
  "product": "string",
  "provider": "digicert",
  "dns_names": [
    "string"
  ],
  "action_required": true,
  "pending_reason": "string",
  "pending_message": "string",
  "completion_url": "string",
  "organization_id": "string",
  "organization": {
    "id": "hdl_7K9QW3M2ZT8HJ",
    "name": "string",
    "status": "ready",
    "usable_for_ordering": true
  },
  "order_state": "string",
  "revocation_scope": "certificate",
  "revocation_pending_scope": "certificate",
  "reissue_supported": true,
  "validity_days": 0,
  "renewal_bonus_days": 0,
  "serial_number": "string",
  "valid_from": "2026-01-01T00:00:00Z",
  "valid_until": "2026-01-01T00:00:00Z",
  "contract_valid_from": "2026-01-01T00:00:00Z",
  "contract_valid_until": "2026-01-01T00:00:00Z",
  "last_status_check": "2026-01-01T00:00:00Z",
  "certificate_pem_available": true,
  "order_cancellable": true,
  "order_cancellation_mode": "cancel_pending",
  "order_cancellable_until": "2026-01-01T00:00:00Z",
  "validation": {
    "method": "dns-cname-token",
    "dns_records": [
      {
        "name": "www.example.com.",
        "type": "CNAME",
        "value": "www.example.com."
      }
    ],
    "email_targets": [
      "string"
    ]
  },
  "reissue": {
    "id": 0,
    "status": "pending",
    "common_name": "string",
    "dns_names": [
      "string"
    ],
    "order_state": "string",
    "requested_at": "2026-01-01T00:00:00Z",
    "last_updated_at": "2026-01-01T00:00:00Z",
    "validation": {
      "method": "dns-cname-token",
      "dns_records": [
        {
          "name": "www.example.com.",
          "type": "CNAME",
          "value": "www.example.com."
        }
      ],
      "email_targets": [
        "string"
      ]
    }
  }
}

Used by

Section titled “Used by”