## List Client Certificates `client_certificates.list(ClientCertificateListParams**kwargs) -> SyncV4PagePaginationArray[ClientCertificate]` **get** `/zones/{zone_id}/client_certificates` List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination ### Parameters - `zone_id: str` Identifier. - `limit: Optional[int]` Limit to the number of records returned. - `offset: Optional[int]` Offset the results - `page: Optional[float]` Page number of paginated results. - `per_page: Optional[float]` Number of records per page. - `status: Optional[Literal["all", "active", "pending_reactivation", 2 more]]` Client Certitifcate Status to filter results by. - `"all"` - `"active"` - `"pending_reactivation"` - `"pending_revocation"` - `"revoked"` ### Returns - `class ClientCertificate: …` - `id: Optional[str]` Identifier. - `certificate: Optional[str]` The Client Certificate PEM - `certificate_authority: Optional[CertificateAuthority]` Certificate Authority used to issue the Client Certificate - `id: Optional[str]` - `name: Optional[str]` - `common_name: Optional[str]` Common Name of the Client Certificate - `country: Optional[str]` Country, provided by the CSR - `csr: Optional[str]` The Certificate Signing Request (CSR). Must be newline-encoded. - `expires_on: Optional[str]` Date that the Client Certificate expires - `fingerprint_sha256: Optional[str]` Unique identifier of the Client Certificate - `issued_on: Optional[str]` Date that the Client Certificate was issued by the Certificate Authority - `location: Optional[str]` Location, provided by the CSR - `organization: Optional[str]` Organization, provided by the CSR - `organizational_unit: Optional[str]` Organizational Unit, provided by the CSR - `serial_number: Optional[str]` The serial number on the created Client Certificate. - `signature: Optional[str]` The type of hash used for the Client Certificate.. - `ski: Optional[str]` Subject Key Identifier - `state: Optional[str]` State, provided by the CSR - `status: Optional[Status]` Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions - `"active"` - `"pending_reactivation"` - `"pending_revocation"` - `"revoked"` - `validity_days: Optional[int]` The number of days the Client Certificate will be valid after the issued_on date ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.client_certificates.list( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "certificate": "-----BEGIN CERTIFICATE-----\nMIIDmDCCAoC...dhDDE\n-----END CERTIFICATE-----", "certificate_authority": { "id": "568b6b74-7b0c-4755-8840-4e3b8c24adeb", "name": "Cloudflare Managed CA for account" }, "common_name": "Cloudflare", "country": "US", "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICY....\n-----END CERTIFICATE REQUEST-----", "expires_on": "2033-02-20T23:18:00Z", "fingerprint_sha256": "256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea", "issued_on": "2023-02-23T23:18:00Z", "location": "Somewhere", "organization": "Organization", "organizational_unit": "Organizational Unit", "serial_number": "3bb94ff144ac567b9f75ad664b6c55f8d5e48182", "signature": "SHA256WithRSA", "ski": "8e375af1389a069a0f921f8cc8e1eb12d784b949", "state": "CA", "status": "active", "validity_days": 3650 } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```