API Reference

Origin TLS Client Auth

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Zone Certificates

List Certificates

client.originTLSClientAuth.zoneCertificates.list(ZoneCertificateListParams { zone_id } params, RequestOptionsoptions?): SinglePage<ZoneCertificateListResponse { id, certificate, enabled, private_key } >

GET/zones/{zone_id}/origin_tls_client_auth

Get Certificate Details

client.originTLSClientAuth.zoneCertificates.get(stringcertificateId, ZoneCertificateGetParams { zone_id } params, RequestOptionsoptions?): ZoneCertificateGetResponse { id, certificate, enabled, private_key }

GET/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

Upload Certificate

client.originTLSClientAuth.zoneCertificates.create(ZoneCertificateCreateParams { zone_id, certificate, private_key } params, RequestOptionsoptions?): ZoneCertificateCreateResponse { id, certificate, enabled, private_key }

POST/zones/{zone_id}/origin_tls_client_auth

Delete Certificate

client.originTLSClientAuth.zoneCertificates.delete(stringcertificateId, ZoneCertificateDeleteParams { zone_id } params, RequestOptionsoptions?): ZoneCertificateDeleteResponse { id, certificate, enabled, private_key }

DELETE/zones/{zone_id}/origin_tls_client_auth/{certificate_id}

ModelsExpand Collapse

ZoneAuthenticatedOriginPull { id, certificate, expires_on, 4 more }

id?: string

Identifier.

maxLength32

certificate?: string

The zone’s leaf certificate.

expires_on?: string

When the certificate from the authority expires.

formatdate-time

issuer?: string

The certificate authority that issued the certificate.

signature?: string

The type of hash used for the certificate.

status?: "initializing" | "pending_deployment" | "pending_deletion" | 4 more

Status of the certificate activation.

One of the following:

"initializing"

"pending_deployment"

"pending_deletion"

"active"

"deleted"

"deployment_timed_out"

"deletion_timed_out"

uploaded_on?: string

This is the time the certificate was uploaded.

formatdate-time

ZoneCertificateListResponse extends ZoneAuthenticatedOriginPull { id, certificate, expires_on, 4 more } { id, certificate, enabled, private_key }

id?: string

Identifier.

maxLength32

certificate?: string

The zone’s leaf certificate.

enabled?: boolean

Indicates whether zone-level authenticated origin pulls is enabled.

private_key?: string

The zone’s private key.

ZoneCertificateGetResponse extends ZoneAuthenticatedOriginPull { id, certificate, expires_on, 4 more } { id, certificate, enabled, private_key }

id?: string

Identifier.

maxLength32

certificate?: string

The zone’s leaf certificate.

enabled?: boolean

Indicates whether zone-level authenticated origin pulls is enabled.

private_key?: string

The zone’s private key.

ZoneCertificateCreateResponse extends ZoneAuthenticatedOriginPull { id, certificate, expires_on, 4 more } { id, certificate, enabled, private_key }

id?: string

Identifier.

maxLength32

certificate?: string

The zone’s leaf certificate.

enabled?: boolean

Indicates whether zone-level authenticated origin pulls is enabled.

private_key?: string

The zone’s private key.

ZoneCertificateDeleteResponse extends ZoneAuthenticatedOriginPull { id, certificate, expires_on, 4 more } { id, certificate, enabled, private_key }

id?: string

Identifier.

maxLength32

certificate?: string

The zone’s leaf certificate.

enabled?: boolean

Indicates whether zone-level authenticated origin pulls is enabled.

private_key?: string

The zone’s private key.