List Client Certificates

GET /zones/{zone_id}/client_certificates

Copy endpoint

https://api.cloudflare.com/client/v4

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

Parameters

path Path Parameters

Name	Type
`zone_id` required	type TlsCertificatesAndHostnamesIdentifier = string

query Query Parameters

Name	Type
`status`	"all" \| "active" \| "pending_reactivation" \| "pending_revocation" \| "revoked"
`page`	number
`per_page`	number
`limit`	number
`offset`	number

Responses

200 application/json

List Client Certificates Response

type TlsCertificatesAndHostnamesClientCertificateResponseCollection = type TlsCertificatesAndHostnamesApiResponseCollection = never & { result?:

TlsCertificatesAndHostnamesClientCertificate

interface TlsCertificatesAndHostnamesClientCertificate {
certificate?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasCertificate;
certificate_authority?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasCertificateAuthority;
common_name?: TlsCertificatesAndHostnamesCommonName;
country?: TlsCertificatesAndHostnamesCountry;
csr?: TlsCertificatesAndHostnamesSchemasCsr;
expires_on?: TlsCertificatesAndHostnamesExpiredOn;
fingerprint_sha256?: TlsCertificatesAndHostnamesFingerprintSha256;
id?: TlsCertificatesAndHostnamesIdentifier;
issued_on?: TlsCertificatesAndHostnamesIssuedOn;
location?: TlsCertificatesAndHostnamesLocation;
organization?: TlsCertificatesAndHostnamesOrganization;
organizational_unit?: TlsCertificatesAndHostnamesOrganizationalUnit;
serial_number?: TlsCertificatesAndHostnamesComponentsSchemasSerialNumber;
signature?: TlsCertificatesAndHostnamesComponentsSchemasSignature;
ski?: TlsCertificatesAndHostnamesSki;
state?: TlsCertificatesAndHostnamesState;
status?: TlsCertificatesAndHostnamesClientCertificatesComponentsSchemasStatus;
validity_days?: TlsCertificatesAndHostnamesSchemasValidityDays;
}

[]; }

Client Errors

4XX application/json

List Client Certificates Response Failure

interface TlsCertificatesAndHostnamesApiResponseCommonFailure {
errors:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

TlsCertificatesAndHostnamesMessages

type TlsCertificatesAndHostnamesMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}