Skip to main content
Deployment guide

Management UI SSL

Configure Management UI SSL to receive renewed certificates automatically.

1. Overview​

A TrueNAS - Management UI SSL node deploys certificates to this configured target.

2. Configuration​

Select this platform and deployment position, then supply the following parameters.

FieldRequiredDescription
TrueNAS HTTPS URLYeshttps://truenas.example.com
API Key Owner UsernameYes
API KeyYes
Verify TLS CertificateYesYes (recommended) / No (self-signed server certificate); default: true

3. Deployment and renewal​

  • Requires TrueNAS SCALE 25.10 with JSON-RPC 2.0 and auth.login_ex API key authentication. The key owner must have certificate and system general configuration permissions. Only the management UI certificate is changed; FTP and applications retain their certificates.

Associate the certificate with the node and enable automatic deployment on renewal. Certificate replacement uses the same configured target on every run.

The endpoint must use HTTPS and be reachable from the CertOne deployment service. TLS certificate verification is enabled by default. Disable verification only when the target has a self-signed certificate and its address is trusted.

Old certificate objects are retained to avoid deleting certificates referenced elsewhere. Monitor the platform certificate quota and remove unused objects separately. Repeating a successful deployment of the same PEM certificate reuses its generated certificate name.

The client uses wss://<host>/api/current and the official auth.login_ex API key mechanism. It waits for the certificate import job before binding ui_certificate and scheduling a UI reload. Older REST and legacy WebSocket APIs are not supported. After upgrading TrueNAS, confirm API compatibility before enabling scheduled deployment.

4. Verification​

Automated protocol tests cover request construction, failure handling and credential redaction. This integration has not been tested against a live account or device in this change. A successful configuration check verifies connectivity and read access; the first deployment also verifies write permissions.

Platform API documentation