Docs / Getting started
From signup to your first subnet
Everything in nxip is reachable over HTTP - pick whichever path matches how you actually work. This page walks through the raw API with curl, useful for seeing the shape of it regardless of which path you end up using day to day.
nxip-cli
The same plan/apply loop as Terraform, from a YAML manifest, no HCL required.
nxip-cli docs →The raw API, with curl
1. Sign up and get an API key
Sign up with your email and organization name. You'll get a verification link, and clicking it creates your organization and issues your first API key, shown once. Store it somewhere safe; nxip never displays it again.
2. Create a pool
A pool is the top-level CIDR block you carve subnets from, scoped to one environment, region, and address family.
curl -X POST https://nxip.dev/v1/pools \
-H "x-api-key: $NXIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Production US-East",
"cidr": "10.100.0.0/16",
"family": "IPV4",
"environment": "production",
"region": "us-east-1"
}'3. Create a subnet
Ask for a /24 and nxip picks the next free, non-overlapping block from the matching pool automatically.
curl -X POST https://nxip.dev/v1/subnets \
-H "x-api-key: $NXIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"environment": "production",
"region": "us-east-1",
"family": "IPV4",
"prefixLength": 24,
"name": "Payments team"
}'The response includes the allocated cidr: the block nxip picked for you.
Next: read how pools, subnets, and hierarchy fit together, or pick a declarative path, Terraform or nxip-cli, from the options above.