Docs

Guides for working with nxip

Concept guides and walkthroughs live here. For the full endpoint-by-endpoint reference (every route, request and response shape) see the live API reference.

Where does your data live today?

Start here. Five situations cover almost everyone.

Nothing yet, starting freshCreate your first pool and subnet directly.Getting started →Deployed in AWS or AzureScan it, see what collides, load it in exactly as it is.Environment discovery →You already know your CIDRsRegister the exact blocks you already run - on-prem, another cloud, anywhere.Getting your data in →Tracked in a spreadsheetGuided import is on the way; here is the practical path today.Getting your data in →Already in nxip, want Terraform to manage itBring it under management without recreating anything.Importing into Terraform →

Or browse every guide

Getting started

From signup to your first pool and subnet, using curl.

Getting your data in

Five situations cover almost everyone bringing existing or new address space into nxip - find yours.

Environment discovery

Find the IP space you already have across AWS and Azure, see where it collides, and load it in as a registry you can trust.

Pools, subnets & hierarchy

How address space is organized, and how nesting and auto-resolution work.

Working with metadata

Tag pools, subnets, and addresses with your own key/value data, and put on-prem sites on the map.

Quick start with Terraform

Pool, subnet, nested subnet, and address, working end to end in a couple of minutes.

Quick start with Terraform: IPv6

The same walkthrough, entirely in IPv6.

Importing existing resources into Terraform

Bring nxip pools and subnets you already have under Terraform management, without recreating anything.

Collision-aware PR reviews

A GitHub Action that shows reviewers the exact CIDR and utilization impact of a subnet change before it's applied.

Multi-cluster Kubernetes CIDR authority

Carve guaranteed non-overlapping pod and service CIDR blocks for EKS, AKS, and GKE clusters, before the cluster exists.

nxip-cli: plan and apply without Terraform

Declare subnets in YAML and get the same plan/apply reconciliation loop, for teams who will never adopt HCL.

API keys & roles

Admin, Member, and Read-only: what each can do, and how to scope a key.

Customer organizations

For MSPs and ISPs: manage many customers from one login, each in its own isolated organization.

API reference →

Every endpoint, request and response schema, generated from the live API.

More guides (multi-region address plans, the Telco/MSP hierarchy model, IPv6 patterns) are on the way. Missing something you need now? Tell us.