The nullplatform agent
The nullplatform agent is a lightweight service you can run anywhere, from your laptop to a Kubernetes cluster. It connects your environment securely to the nullplatform API, so you can automate tasks, monitor scopes and services, trigger actions, and handle event-based notifications without exposing your infrastructure.
ℹ️ This setup is privacy-first: your data stays in your cluster. Only minimal metadata and telemetry are sent to nullplatform.
Required setup path
Follow this order so the agent can actually execute work:
- Create an API key with the Agent and Ops role.
- Install the agent and pass the API key as
NP_API_KEY. - Create an agent notification channel that targets this agent.
How it works
The agent is a small binary that can run in many ways, on your local machine, in a container, or on a Kubernetes cluster (via Helm, Docker, or just the binary). Here's what it does:
- Authenticates with the nullplatform API using your API key
- Registers itself with optional tags (e.g.
environment:dev,team:secops) - Polls the API for matching tasks, scopes, or triggers
- Runs matching commands or workflows inside your environment
- Optionally sends logs, telemetry, and results back to nullplatform
🔒 The agent is outbound-only. It only needs to be able to connect to
agents.nullplatform.comon port443.
Minimal flow
Key features at a glance
| Feature | Description |
|---|---|
| Tag-based routing | Agents only respond to tasks that match their tags |
| Secure API integration | Use API keys with fine-grained access |
| Notification channels | Run local scripts in response to platform events, using a git-audited flow |
| Flexible runtime options | Deploy the agent using Helm (K8s), Docker, binary, or serverless (e.g. Lambda) |
| Observability | Capture logs, exit codes, and outputs from workflows inside your infra. (Note: the agent itself doesn’t expose internal monitoring) |
| Multiple deployment models | Use in local dev (e.g. Minikube), cloud environments (e.g. EKS, GKE), or CI/CD pipelines |
What’s next
Explore the following pages to learn more:
- Authentication: Configure API keys with NRN-scoped permissions for agents
- Installation: Install the agent with Helm and verify it's working
- Notification channels: Let platform events trigger your local scripts