---
title: Client Certificates
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Client Certificates

##### [List Client Certificates](https://developers.cloudflare.com/api/typescript/resources/client_certificates/methods/list)

client.clientCertificates.list(ClientCertificateListParams {zone\_id, limit, offset, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray< [ClientCertificate](<https://developers.cloudflare.com/api/typescript/resources/client_certificates#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>) {id, certificate, certificate\_authority, 15 more } >

GET/zones/{zone\_id}/client\_certificates

##### [Client Certificate Details](https://developers.cloudflare.com/api/typescript/resources/client_certificates/methods/get)

client.clientCertificates.get(stringclientCertificateID, ClientCertificateGetParams {zone\_id } params, RequestOptionsoptions?): [ClientCertificate](<https://developers.cloudflare.com/api/typescript/resources/client_certificates#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>) {id, certificate, certificate\_authority, 15 more }

GET/zones/{zone\_id}/client\_certificates/{client\_certificate\_id}

##### [Create Client Certificate](https://developers.cloudflare.com/api/typescript/resources/client_certificates/methods/create)

client.clientCertificates.create(ClientCertificateCreateParams {zone\_id, csr, validity\_days } params, RequestOptionsoptions?): [ClientCertificate](<https://developers.cloudflare.com/api/typescript/resources/client_certificates#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>) {id, certificate, certificate\_authority, 15 more }

POST/zones/{zone\_id}/client\_certificates

##### [Reactivate Client Certificate](https://developers.cloudflare.com/api/typescript/resources/client_certificates/methods/edit)

client.clientCertificates.edit(stringclientCertificateID, ClientCertificateEditParams {zone\_id, reactivate } params, RequestOptionsoptions?): [ClientCertificate](<https://developers.cloudflare.com/api/typescript/resources/client_certificates#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>) {id, certificate, certificate\_authority, 15 more }

PATCH/zones/{zone\_id}/client\_certificates/{client\_certificate\_id}

##### [Revoke Client Certificate](https://developers.cloudflare.com/api/typescript/resources/client_certificates/methods/delete)

client.clientCertificates.delete(stringclientCertificateID, ClientCertificateDeleteParams {zone\_id } params, RequestOptionsoptions?): [ClientCertificate](<https://developers.cloudflare.com/api/typescript/resources/client_certificates#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>) {id, certificate, certificate\_authority, 15 more }

DELETE/zones/{zone\_id}/client\_certificates/{client\_certificate\_id}

##### ModelsExpand Collapse

<details>

<summary>

ClientCertificate {id, certificate, certificate\_authority, 15 more }

</summary>

id?: string

Client Certificate Tag

maxLength36

minLength36

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

certificate?: string

The Client Certificate PEM.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20certificate">Link to this property</a>

<details>

<summary>

certificate\_authority?: CertificateAuthority {id, name }

Certificate Authority used to issue the Client Certificate.

</summary>

id?: string

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20certificate_authority%20%3E%20(property)%20id">Link to this property</a>

name?: string

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20certificate_authority%20%3E%20(property)%20name">Link to this property</a>

</details>

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20certificate_authority">Link to this property</a>

common\_name?: string

Common Name of the Client Certificate.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20common_name">Link to this property</a>

country?: string

Country, provided by the CSR.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20country">Link to this property</a>

csr?: string

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

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20csr">Link to this property</a>

expires\_on?: string

Date that the Client Certificate expires.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20expires_on">Link to this property</a>

fingerprint\_sha256?: string

Unique identifier of the Client Certificate.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20fingerprint_sha256">Link to this property</a>

issued\_on?: string

Date that the Client Certificate was issued by the Certificate Authority.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20issued_on">Link to this property</a>

location?: string

Location, provided by the CSR.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20location">Link to this property</a>

organization?: string

Organization, provided by the CSR.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20organization">Link to this property</a>

organizational\_unit?: string

Organizational Unit, provided by the CSR.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20organizational_unit">Link to this property</a>

serial\_number?: string

The serial number on the created Client Certificate.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20serial_number">Link to this property</a>

signature?: string

The type of hash used for the Client Certificate..

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20signature">Link to this property</a>

ski?: string

Subject Key Identifier.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20ski">Link to this property</a>

state?: string

State, provided by the CSR.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

<details>

<summary>

status?: "active"| "pending\_reactivation"| "pending\_revocation"| "revoked"

Client Certificates may be active or revoked, and the pending\_reactivation or pending\_revocation represent in-progress asynchronous transitions.

</summary>

One of the following:

"active"

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"pending\_reactivation"

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

"pending\_revocation"

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

"revoked"

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

validity\_days?: number

The number of days the Client Certificate will be valid after the issued\_on date.

<a href="#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)%20%3E%20(property)%20validity_days">Link to this property</a>

</details>

[Link to this property](<#(resource)%20client_certificates%20%3E%20(model)%20client_certificate%20%3E%20(schema)>)