API referenceObjectstunnel_certificate

The tunnel certificate object

⚠️
Preview — this feature is being built; the design below is the spec.

The tunnel_certificate object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "tcert_01JCE9K1M3P5R7T9V1X3",
  "type": "tunnel_certificate",
  "tunnel_id": "tnl_01JCE4G6J8L0N2Q4S6U8",
  "subject": "CN=erp-onprem-connector-1",
  "serial": "4A:91:0C:7E:22:5B",
  "fingerprint_sha256": "b2:7e:…:91",
  "not_before": "2026-11-05T10:00:00Z",
  "not_after": "2027-02-03T10:00:00Z",
  "status": "active",
  "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIID…\n-----END CERTIFICATE-----",
  "chain_pem": "-----BEGIN CERTIFICATE-----\nMIIF…\n-----END CERTIFICATE-----"
}

Fields

FieldTypeDescription
idstringUnique id of this object.
typestringThe object type, always tunnel_certificate.
tunnel_idstringSee the endpoint pages below.
subjectstringSee the endpoint pages below.
serialstringSee the endpoint pages below.
fingerprint_sha256stringSee the endpoint pages below.
not_beforestringSee the endpoint pages below.
not_afterstringCertificates are valid for 90 days. Issue the next one before this date.
statusstringactive, expired or revoked.
certificate_pemstringInstall next to the connector’s private key.
chain_pemstringThe issuing chain.

Returned by

Was this page helpful?