Zum Inhalt springen
regfish Doku

tlsCertificateResponse

Keine Beschreibung in der Spezifikation vorhanden.

Felder

Abschnitt betitelt „Felder“
Feld Typ Pflicht Beschreibung
id tlsCertificateId ja Öffentliche TLS-Zertifikats-ID
status tlsCertificateStatus ja (pending, issued, pending_cancellation, pending_revocation, pending_order_revocation, cancelled, order_cancelled, revoked, order_revoked, rejected, expired, unknown)
common_name string ja —
product string ja —
provider tlsCertificateProvider ja (digicert)
dns_names string[] ja —
action_required boolean ja —
pending_reason string ja —
pending_message string ja —
completion_url string ja Absolute URL, unter der sich die noch fehlenden Bestelldaten in der Weboberfläche ergänzen lassen. API-Clients können stattdessen /tls/certificate/{certificate_id}/complete verwenden.
organization_id string ja —
organization tlsCertificateOrganization nein —
order_state string nein —
revocation_scope tlsCertificateRevocationScope nein (certificate, order)
revocation_pending_scope tlsCertificateRevocationScope nein (certificate, order)
reissue_supported boolean nein —
validity_days integer nein Gekaufte Grundlaufzeit der Bestellung in Tagen, so wie sie für die Bestellung übermittelt wurde. Bei Verlängerungen über den Provider kann die effektiv ausgestellte Zertifikatslaufzeit länger sein. Maßgeblich für die ausgestellte Laufzeit sind valid_from und valid_until.
renewal_bonus_days integer nein Bestätigte zusätzliche Gültigkeitstage über validity_days hinaus, ermittelt aus dem tatsächlich ausgestellten Verlängerungszertifikat. Dieses Feld ist nur bei Verlängerungszertifikaten vorhanden, sobald sich die effektiv ausgestellte Laufzeit bestimmen lässt.
serial_number string nein —
valid_from string nein —
valid_until string nein Maßgeblicher Ablaufzeitpunkt des aktuell ausgestellten Zertifikats. Bei Verlängerungen über den Provider kann er später liegen, als validity_days vermuten lässt, wenn der Provider die Restlaufzeit des bisherigen Zertifikats anrechnet.
contract_valid_from string nein —
contract_valid_until string nein —
last_status_check string nein —
certificate_pem_available boolean ja —
order_cancellable boolean nein —
order_cancellation_mode tlsCertificateOrderCancellationMode nein (cancel_pending, revoke_issued)
order_cancellable_until string nein —
validation tlsValidation nein —
reissue tlsCertificateReissueResponse nein —

Beispiel

Abschnitt betitelt „Beispiel“
{
  "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"
      ]
    }
  }
}

Verwendet von

Abschnitt betitelt „Verwendet von“