Skip to main content

Apex

Apex is an edge system that runs assessment work inside your network. Where a Scanner executes discovery and vulnerability tasks handed to it, Apex additionally runs guided assessment sessions - scans, vulnerability scans, campaigns, and scheduled work - and produces reports from them.

It ships as cyberoptix.apex and runs a single service, apex-daemon, which polls for work every 30 seconds.

Before you start​

  • Ubuntu Server 24.04, with root or sudo access.
  • Outbound HTTPS to your platform's API hostname. No inbound connections are needed.
  • Your organization ID from the platform.
  • Outbound access to ghcr.io and docker.io so the tool containers can be pulled.

Install​

If this host has never had a Purple Team Software package on it, add the repository. Include the rm -f - gpg --dearmor prompts before overwriting an existing keyring, and on a re-run that prompt has nothing attached to answer it:

sudo rm -f /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg
wget -O - https://apt.fury.io/purpleteamsoftware/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/purpleteamsoftware-archive-keyring.gpg] https://apt.purpleteamsoftware.com/ /" | sudo tee /etc/apt/sources.list.d/purpleteamsoftware.list
sudo apt update && sudo apt install cyberoptix.apex -y

Installation pulls in Docker and brings up the tool stack defined in /etc/optix/docker-compose-apex.yml. The assessment toolchain is not installed on the host: redis, nmap, nuclei, ZAP, the headless browser and the Kali toolset all run as containers, which is why the only packages added to your server are Docker and a handful of small utilities.

A scoped /etc/sudoers.d/cyberoptix-apex allows dmidecode (for the hardware UUID) and the account-management commands Apex uses to provision logins.

Apex does not run as root

The daemon runs as the unprivileged optix user. It is added to the docker group so it can start tool containers. Note that membership of the docker group is equivalent to root on that host, so treat an Apex server as a dedicated machine rather than one shared with unrelated workloads.

Installing does nothing on its own. Linking binds the host to your organization:

sudo apex link --url https://<your-api-hostname> --organization_id <your-organization-id>

That writes baseurl, credentials, mode and organization_id to /etc/optix/apex-config.json.

Linking is also what enables the assessment features that call out to a language model. Those requests are proxied through the platform API rather than going direct, so key management and billing stay on the platform side and the host holds no model provider credentials of its own. An unlinked Apex has no access to them at all.

Start the daemon​

sudo systemctl enable --now apex-daemon.service
systemctl status --no-pager apex-daemon docker
docker compose -f /etc/optix/docker-compose-apex.yml ps

apex-daemon and docker should both be active (running), and the compose stack should list redis, owaspZap and chromium as up. The daemon polls every 30 seconds, so give it that long before concluding nothing is happening:

sudo journalctl -u apex-daemon.service -f

Then confirm Apex appears in the platform under Validation Operations.

Configuration​

Defaults live in /etc/optix/apex.yaml. The settings worth knowing:

SettingDefaultPurpose
agent.max_concurrent_tools5How many tools run at once
agent.default_timeout_secs30Per-tool timeout
agent.session_dir/var/lib/optix/apex/sessionsWhere session state is kept
safety.allowed_scopeemptyTargets Apex may act on
safety.no_go_zonesemptyTargets it must never touch
safety.max_risk_levelmediumCeiling on action risk
caution
Set safety.allowed_scope and no_go_zones

Both ship empty. These are Apex's own guardrails, and they are the difference between an assessment confined to what you intended and one that reaches further. Set them before running anything against a production network.

Running work​

Apex is driven from the platform, but the same operations are available locally:

apex scan --help
apex vulnscan --help
apex campaign --help
apex report --help

A session interrupted part-way can be picked up rather than restarted:

apex resume --help
apex version

Next​

  • Scanners - the lighter-weight alternative for pure discovery and scanning
  • Troubleshooting - an Apex host that is not reporting in
  • Host hardening - what the package changes on the host, and sharing a host with a Scanner