Skip to content
Start here

Client Certificates

List Client Certificates
client_certificates.list(ClientCertificateListParams**kwargs) -> SyncV4PagePaginationArray[ClientCertificate]
GET/zones/{zone_id}/client_certificates
Client Certificate Details
client_certificates.get(strclient_certificate_id, ClientCertificateGetParams**kwargs) -> ClientCertificate
GET/zones/{zone_id}/client_certificates/{client_certificate_id}
Create Client Certificate
client_certificates.create(ClientCertificateCreateParams**kwargs) -> ClientCertificate
POST/zones/{zone_id}/client_certificates
Reactivate Client Certificate
client_certificates.edit(strclient_certificate_id, ClientCertificateEditParams**kwargs) -> ClientCertificate
PATCH/zones/{zone_id}/client_certificates/{client_certificate_id}
Revoke Client Certificate
client_certificates.delete(strclient_certificate_id, ClientCertificateDeleteParams**kwargs) -> ClientCertificate
DELETE/zones/{zone_id}/client_certificates/{client_certificate_id}
ModelsExpand Collapse
class ClientCertificate:
id: Optional[str]

Identifier.

maxLength32
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

validity_days: Optional[int]

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