Skip to content
Start here

MTLS Certificates

List mTLS certificates
client.mtlsCertificates.list(MTLSCertificateListParams { account_id } params, RequestOptionsoptions?): SinglePage<MTLSCertificate { id, ca, certificates, 6 more } >
GET/accounts/{account_id}/mtls_certificates
Get mTLS certificate
client.mtlsCertificates.get(stringmtlsCertificateId, MTLSCertificateGetParams { account_id } params, RequestOptionsoptions?): MTLSCertificate { id, ca, certificates, 6 more }
GET/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
Upload mTLS certificate
client.mtlsCertificates.create(MTLSCertificateCreateParams { account_id, ca, certificates, 2 more } params, RequestOptionsoptions?): MTLSCertificateCreateResponse { id, ca, certificates, 7 more }
POST/accounts/{account_id}/mtls_certificates
Delete mTLS certificate
client.mtlsCertificates.delete(stringmtlsCertificateId, MTLSCertificateDeleteParams { account_id } params, RequestOptionsoptions?): MTLSCertificate { id, ca, certificates, 6 more }
DELETE/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
ModelsExpand Collapse
MTLSCertificate { id, ca, certificates, 6 more }
id?: string

Identifier.

maxLength32
ca?: boolean

Indicates whether the certificate is a CA or leaf certificate.

certificates?: string

The uploaded root CA certificate.

expires_on?: string

When the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

name?: string

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

serial_number?: string

The certificate serial number.

signature?: string

The type of hash used for the certificate.

uploaded_on?: string

This is the time the certificate was uploaded.

formatdate-time
MTLSCertificateCreateResponse { id, ca, certificates, 7 more }
id?: string

Identifier.

maxLength32
ca?: boolean

Indicates whether the certificate is a CA or leaf certificate.

certificates?: string

The uploaded root CA certificate.

expires_on?: string

When the certificate expires.

formatdate-time
issuer?: string

The certificate authority that issued the certificate.

name?: string

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

serial_number?: string

The certificate serial number.

signature?: string

The type of hash used for the certificate.

updated_at?: string

This is the time the certificate was updated.

formatdate-time
uploaded_on?: string

This is the time the certificate was uploaded.

formatdate-time

MTLS CertificatesAssociations

List mTLS certificate associations
client.mtlsCertificates.associations.get(stringmtlsCertificateId, AssociationGetParams { account_id } params, RequestOptionsoptions?): SinglePage<CertificateAsssociation { service, status } >
GET/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations
ModelsExpand Collapse
CertificateAsssociation { service, status }
service?: string

The service using the certificate.

status?: string

Certificate deployment status for the given service.