Client Certificates

client_certificates

Methods

Create Client Certificate -> Envelope<>
post/zones/{zone_id}/client_certificates

Create a new API Shield mTLS Client Certificate

Revoke Client Certificate -> Envelope<>
delete/zones/{zone_id}/client_certificates/{client_certificate_id}

Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.

Reactivate Client Certificate -> Envelope<>
patch/zones/{zone_id}/client_certificates/{client_certificate_id}

If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.

Client Certificate Details -> Envelope<>
get/zones/{zone_id}/client_certificates/{client_certificate_id}

Get Details for a single mTLS API Shield Client Certificate

List Client Certificates -> V4PagePaginationArray<>
get/zones/{zone_id}/client_certificates

List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination

Security
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

SSL and Certificates Write SSL and Certificates Read

Parameters
zone_id: string
(maxLength: 32)

Identifier

limit: number
Optional

Limit to the number of records returned.

offset: number
Optional

Offset the results

page: number
Optional
(minimum: 1)

Page number of paginated results.

per_page: number
Optional
(maximum: 50, minimum: 5)

Number of records per page.

status:
Optional

Client Certitifcate Status to filter results by.

"all"
"active"
"pending_reactivation"
"pending_revocation"
"revoked"
Response fields
errors: Array<>
messages: Array<>
success: true

Whether the API call was successful

result: Array<>
Optional
result_info: { count, page, per_page, 1 more... }
Optional
Request example
200Example

Domain types

ClientCertificate = { id, certificate, certificate_authority, 15 more... }