Skip to content

TLSConfig

Part of Configuration & authentication in the Python API reference.

Related guidance: getting-started/configuration, getting-started/authentication, security/credentials.

Runnable examples: preflight.py.

from picogrid_ecn_client import TLSConfig

Configure TLS transport and optional custom certificate authority material.

TLSConfig(
*,
enabled: bool = True,
verify: bool = True,
ca_certificate: CertificateMaterial | None = None,
)

Source · auth.py

NameTypeRequiredDefaultConstraintsDescription
enabledboolnoTrueWhether TLS transport is enabled; defaults to true.
verifyboolnoTrueWhether TLS peer certificates are verified; defaults to true.
ca_certificateCertificateMaterial | NonenoNoneOptional custom certificate-authority material; requires TLS.

Version 0.2.0 · branch main