Skip to content
Start here

MTLS Certificates

List mTLS certificates
mtls_certificates.list(MTLSCertificateListParams**kwargs) -> SyncSinglePage[MTLSCertificate]
GET/accounts/{account_id}/mtls_certificates
Get mTLS certificate
mtls_certificates.get(strmtls_certificate_id, MTLSCertificateGetParams**kwargs) -> MTLSCertificate
GET/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
Upload mTLS certificate
mtls_certificates.create(MTLSCertificateCreateParams**kwargs) -> MTLSCertificateCreateResponse
POST/accounts/{account_id}/mtls_certificates
Delete mTLS certificate
mtls_certificates.delete(strmtls_certificate_id, MTLSCertificateDeleteParams**kwargs) -> MTLSCertificate
DELETE/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
ModelsExpand Collapse
class MTLSCertificate:
id: Optional[str]

Identifier.

maxLength32
ca: Optional[bool]

Indicates whether the certificate is a CA or leaf certificate.

certificates: Optional[str]

The uploaded root CA certificate.

expires_on: Optional[datetime]

When the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

name: Optional[str]

Optional unique name for the certificate. Only used for human readability.

serial_number: Optional[str]

The certificate serial number.

signature: Optional[str]

The type of hash used for the certificate.

uploaded_on: Optional[datetime]

This is the time the certificate was uploaded.

formatdate-time
class MTLSCertificateCreateResponse:
id: Optional[str]

Identifier.

maxLength32
ca: Optional[bool]

Indicates whether the certificate is a CA or leaf certificate.

certificates: Optional[str]

The uploaded root CA certificate.

expires_on: Optional[datetime]

When the certificate expires.

formatdate-time
issuer: Optional[str]

The certificate authority that issued the certificate.

name: Optional[str]

Optional unique name for the certificate. Only used for human readability.

serial_number: Optional[str]

The certificate serial number.

signature: Optional[str]

The type of hash used for the certificate.

updated_at: Optional[datetime]

This is the time the certificate was updated.

formatdate-time
uploaded_on: Optional[datetime]

This is the time the certificate was uploaded.

formatdate-time

MTLS CertificatesAssociations

List mTLS certificate associations
mtls_certificates.associations.get(strmtls_certificate_id, AssociationGetParams**kwargs) -> SyncSinglePage[CertificateAsssociation]
GET/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations
ModelsExpand Collapse
class CertificateAsssociation:
service: Optional[str]

The service using the certificate.

status: Optional[str]

Certificate deployment status for the given service.