Skip to main content

Support Packages

When you need assistance from the Control Zero support team, a support bundle provides the diagnostic information needed to investigate issues quickly.

Generating a Support Bundle​

Run the support bundle command from any machine with czctl configured:

czctl support-bundle

This creates a compressed archive at:

/opt/controlzero/support/cz-support-<timestamp>.tar.gz

Specifying a time range​

By default, the bundle includes the last 24 hours of data. To specify a different range:

# Last 4 hours
czctl support-bundle --hours 4

# Specific date range
czctl support-bundle --from 2026-04-01T00:00:00 --to 2026-04-02T00:00:00

What Is Collected​

CategoryData Included
Service logsGateway, API, audit database, SSL proxy, Scout (within the specified time range)
Container statedocker compose ps output, container restart counts, health check status
System infoOS version, kernel version, Docker version, available disk and memory
ConfigurationService configuration files with secrets redacted
Health checksOutput of the latest preflight and postflight runs
License infoLicense validity status, seat usage, expiry date (the license key itself is not included)
Network stateListening ports, Docker network configuration

What Is Redacted​

The bundle generator automatically redacts sensitive values before packaging:

  • License keys (replaced with [REDACTED])
  • API keys and tokens
  • Database passwords
  • TLS private keys
  • Any environment variable matching patterns: *_KEY, *_SECRET, *_TOKEN, *_PASSWORD

You can review the bundle contents before sharing:

# Extract and inspect
mkdir /tmp/cz-support-review
tar xzf /opt/controlzero/support/cz-support-<timestamp>.tar.gz -C /tmp/cz-support-review
ls /tmp/cz-support-review/

Sharing with the Support Team​

For environments with outbound network access​

Upload the bundle manually through the Control Zero support portal:

  1. Log in to the Control Zero support portal
  2. Open your support ticket (or create a new one)
  3. Use the upload form to attach the .tar.gz bundle file

For network-isolated environments​

Transfer the bundle to a machine with network access using your approved file transfer mechanism, then share it with the support team via:

  1. The Control Zero support portal (upload form)
  2. A secure file sharing link provided by your support contact
  3. Encrypted email attachment (for bundles under 25 MB)

Self-Service Diagnostics​

Before generating a full support bundle, you can run targeted diagnostics.

Quick status check​

czctl status

This displays the health of all services, container states, and any active warnings.

Targeted diagnostics​

# Gateway connectivity and latency
czctl diagnostics gateway

# Database health and storage usage
czctl diagnostics database

# License validation
czctl diagnostics license

# Network and port checks
czctl diagnostics network

Quick health check​

czctl postflight

Interpreting diagnostic output​

Each diagnostic command outputs results in a structured format:

[pass] Gateway is accepting connections on port 8443
[pass] Policy engine responding in < 5ms
[warn] Audit database disk usage at 78% (threshold: 80%)
[fail] Scout agent has not reported in 2 hours
  • pass: The check succeeded. No action needed.
  • warn: The check passed but a threshold is approaching. Review and plan remediation.
  • fail: The check failed. This is likely contributing to the reported issue.