API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Client Certificates

List Client Certificates

client.clientCertificates.list(ClientCertificateListParams { zone_id, limit, offset, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray<ClientCertificate { id, certificate, certificate_authority, 15 more } >

GET/zones/{zone_id}/client_certificates

Client Certificate Details

client.clientCertificates.get(stringclientCertificateId, ClientCertificateGetParams { zone_id } params, RequestOptionsoptions?): ClientCertificate { id, certificate, certificate_authority, 15 more }

GET/zones/{zone_id}/client_certificates/{client_certificate_id}

Create Client Certificate

client.clientCertificates.create(ClientCertificateCreateParams { zone_id, csr, validity_days } params, RequestOptionsoptions?): ClientCertificate { id, certificate, certificate_authority, 15 more }

POST/zones/{zone_id}/client_certificates

Reactivate Client Certificate

client.clientCertificates.edit(stringclientCertificateId, ClientCertificateEditParams { zone_id, reactivate } params, RequestOptionsoptions?): ClientCertificate { id, certificate, certificate_authority, 15 more }

PATCH/zones/{zone_id}/client_certificates/{client_certificate_id}

Revoke Client Certificate

client.clientCertificates.delete(stringclientCertificateId, ClientCertificateDeleteParams { zone_id } params, RequestOptionsoptions?): ClientCertificate { id, certificate, certificate_authority, 15 more }

DELETE/zones/{zone_id}/client_certificates/{client_certificate_id}

ModelsExpand Collapse

ClientCertificate { id, certificate, certificate_authority, 15 more }

id?: string

Identifier.

maxLength32

certificate?: string

The Client Certificate PEM

certificate_authority?: CertificateAuthority { id, name }

Certificate Authority used to issue the Client Certificate

id?: string

name?: string

common_name?: string

Common Name of the Client Certificate

country?: string

Country, provided by the CSR

csr?: string

The Certificate Signing Request (CSR). Must be newline-encoded.

expires_on?: string

Date that the Client Certificate expires

fingerprint_sha256?: string

Unique identifier of the Client Certificate

issued_on?: string

Date that the Client Certificate was issued by the Certificate Authority

location?: string

Location, provided by the CSR

organization?: string

Organization, provided by the CSR

organizational_unit?: string

Organizational Unit, provided by the CSR

serial_number?: string

The serial number on the created Client Certificate.

signature?: string

The type of hash used for the Client Certificate..

ski?: string

Subject Key Identifier

state?: string

State, provided by the CSR

status?: Status

Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions

validity_days?: number

The number of days the Client Certificate will be valid after the issued_on date