NetBox (Network Documentation)
NetBox is the source of truth for your infrastructure — document IP addresses, VLANs, devices, racks, and virtual machines in a queryable, API-driven database.
Aithroyz deploys NetBox with the sandbox VPC CIDR (
10.0.0.0/24) pre-documented as a prefix. Use it to track all VM IPs and tool assignments for your environment so nothing is undocumented.Access
URL:
https://netbox.<env-name>.ops.aithroyz.comCredentials: Shown in Environments detail → Credentials panel.
Documenting IP space
The sandbox VPC prefix is pre-loaded. Add individual IP addresses as you assign them to tools and VMs:
1.Go to IPAM → Prefixes. The 10.0.0.0/24 VPC prefix should already exist.
2.Click into the prefix to see available addresses, or go to IPAM → IP Addresses → Add.
3.Set the Address field (e.g. 10.0.0.10/24), add a Description (e.g. "Elasticsearch VM"), and assign a Status of Active.
4.Link the IP to a virtual machine interface under the Interface field for full topology tracking.
Adding devices and virtual machines
Each GCE instance in your environment should be documented as a virtual machine:
1.Go to Virtualization → Virtual Machines → Add.
2.Set the Name (e.g. elastic-vm), Platform (e.g. Debian 12), and Status.
3.Add an interface under the Interfaces tab and assign the corresponding IP address.
4.Optionally add the GCP instance ID in a Custom Field for cross-referencing with GCP Console.
API usage
NetBox exposes a full REST API. Generate a token under your user profile (Profile → API Tokens → Add) and use it in requests:
# List all IP addresses
curl -s -H "Authorization: Token <your-netbox-token>" -H "Accept: application/json" https://netbox.<env-name>.ops.aithroyz.com/api/ipam/ip-addresses/ | jq '.results[] | {address, description}'
# Create an IP address via API
curl -s -X POST -H "Authorization: Token <your-netbox-token>" -H "Content-Type: application/json" -d '{"address":"10.0.0.20/24","status":"active","description":"Wazuh manager"}' https://netbox.<env-name>.ops.aithroyz.com/api/ipam/ip-addresses/✓
The interactive API docs are available at
/api/ on your NetBox URL — browse every endpoint with live Try-it-out support.Tips
Custom Fields for GCP metadata
Add a Custom Field of type Text named gcp_instance_id under the Virtual Machine object type. This lets you cross-reference NetBox records with GCP Console and gcloud CLI output.
Webhooks to n8n on IP allocation
Configure a NetBox Webhook (Extras → Webhooks) targeting your n8n webhook URL. Trigger it on IP address create/update events to automatically notify Slack or update a CMDB.
GraphQL API for complex queries
NetBox exposes a GraphQL endpoint at /graphql/. Use it to query related objects in a single request — e.g. all VMs with their interfaces and IPs in one call.