NetBox Labs

NetBox Labs Ipam API

The ipam API from NetBox Labs — 41 operation(s) for ipam.

GitHub OpenAPI
Business capability
Network Inventory Management BC-2600.40

Operations 172

GET /api/ipam/aggregates/ Ipam aggregates list #
POST /api/ipam/aggregates/ Ipam aggregates create #
PUT /api/ipam/aggregates/ Ipam aggregates bulk update #
PATCH /api/ipam/aggregates/ Ipam aggregates bulk partial update #
DELETE /api/ipam/aggregates/ Ipam aggregates bulk destroy #
GET /api/ipam/aggregates/{id}/ Ipam aggregates retrieve #
PUT /api/ipam/aggregates/{id}/ Ipam aggregates update #
PATCH /api/ipam/aggregates/{id}/ Ipam aggregates partial update #
DELETE /api/ipam/aggregates/{id}/ Ipam aggregates destroy #
GET /api/ipam/asn-ranges/ Ipam asn ranges list #
POST /api/ipam/asn-ranges/ Ipam asn ranges create #
PUT /api/ipam/asn-ranges/ Ipam asn ranges bulk update #
PATCH /api/ipam/asn-ranges/ Ipam asn ranges bulk partial update #
DELETE /api/ipam/asn-ranges/ Ipam asn ranges bulk destroy #
GET /api/ipam/asn-ranges/{id}/ Ipam asn ranges retrieve #
PUT /api/ipam/asn-ranges/{id}/ Ipam asn ranges update #
PATCH /api/ipam/asn-ranges/{id}/ Ipam asn ranges partial update #
DELETE /api/ipam/asn-ranges/{id}/ Ipam asn ranges destroy #
GET /api/ipam/asn-ranges/{id}/available-asns/ Ipam asn ranges available asns list #
POST /api/ipam/asn-ranges/{id}/available-asns/ Ipam asn ranges available asns create #
GET /api/ipam/asns/ Ipam asns list #
POST /api/ipam/asns/ Ipam asns create #
PUT /api/ipam/asns/ Ipam asns bulk update #
PATCH /api/ipam/asns/ Ipam asns bulk partial update #
DELETE /api/ipam/asns/ Ipam asns bulk destroy #
GET /api/ipam/asns/{id}/ Ipam asns retrieve #
PUT /api/ipam/asns/{id}/ Ipam asns update #
PATCH /api/ipam/asns/{id}/ Ipam asns partial update #
DELETE /api/ipam/asns/{id}/ Ipam asns destroy #
GET /api/ipam/fhrp-group-assignments/ Ipam fhrp group assignments list #
POST /api/ipam/fhrp-group-assignments/ Ipam fhrp group assignments create #
PUT /api/ipam/fhrp-group-assignments/ Ipam fhrp group assignments bulk update #
PATCH /api/ipam/fhrp-group-assignments/ Ipam fhrp group assignments bulk partial update #
DELETE /api/ipam/fhrp-group-assignments/ Ipam fhrp group assignments bulk destroy #
GET /api/ipam/fhrp-group-assignments/{id}/ Ipam fhrp group assignments retrieve #
PUT /api/ipam/fhrp-group-assignments/{id}/ Ipam fhrp group assignments update #
PATCH /api/ipam/fhrp-group-assignments/{id}/ Ipam fhrp group assignments partial update #
DELETE /api/ipam/fhrp-group-assignments/{id}/ Ipam fhrp group assignments destroy #
GET /api/ipam/fhrp-groups/ Ipam fhrp groups list #
POST /api/ipam/fhrp-groups/ Ipam fhrp groups create #
PUT /api/ipam/fhrp-groups/ Ipam fhrp groups bulk update #
PATCH /api/ipam/fhrp-groups/ Ipam fhrp groups bulk partial update #
DELETE /api/ipam/fhrp-groups/ Ipam fhrp groups bulk destroy #
GET /api/ipam/fhrp-groups/{id}/ Ipam fhrp groups retrieve #
PUT /api/ipam/fhrp-groups/{id}/ Ipam fhrp groups update #
PATCH /api/ipam/fhrp-groups/{id}/ Ipam fhrp groups partial update #
DELETE /api/ipam/fhrp-groups/{id}/ Ipam fhrp groups destroy #
GET /api/ipam/ip-addresses/ Ipam ip addresses list #
POST /api/ipam/ip-addresses/ Ipam ip addresses create #
PUT /api/ipam/ip-addresses/ Ipam ip addresses bulk update #
PATCH /api/ipam/ip-addresses/ Ipam ip addresses bulk partial update #
DELETE /api/ipam/ip-addresses/ Ipam ip addresses bulk destroy #
GET /api/ipam/ip-addresses/{id}/ Ipam ip addresses retrieve #
PUT /api/ipam/ip-addresses/{id}/ Ipam ip addresses update #
PATCH /api/ipam/ip-addresses/{id}/ Ipam ip addresses partial update #
DELETE /api/ipam/ip-addresses/{id}/ Ipam ip addresses destroy #
GET /api/ipam/ip-ranges/ Ipam ip ranges list #
POST /api/ipam/ip-ranges/ Ipam ip ranges create #
PUT /api/ipam/ip-ranges/ Ipam ip ranges bulk update #
PATCH /api/ipam/ip-ranges/ Ipam ip ranges bulk partial update #
DELETE /api/ipam/ip-ranges/ Ipam ip ranges bulk destroy #
GET /api/ipam/ip-ranges/{id}/ Ipam ip ranges retrieve #
PUT /api/ipam/ip-ranges/{id}/ Ipam ip ranges update #
PATCH /api/ipam/ip-ranges/{id}/ Ipam ip ranges partial update #
DELETE /api/ipam/ip-ranges/{id}/ Ipam ip ranges destroy #
GET /api/ipam/ip-ranges/{id}/available-ips/ Ipam ip ranges available ips list #
POST /api/ipam/ip-ranges/{id}/available-ips/ Ipam ip ranges available ips create #
GET /api/ipam/prefixes/ Ipam prefixes list #
POST /api/ipam/prefixes/ Ipam prefixes create #
PUT /api/ipam/prefixes/ Ipam prefixes bulk update #
PATCH /api/ipam/prefixes/ Ipam prefixes bulk partial update #
DELETE /api/ipam/prefixes/ Ipam prefixes bulk destroy #
GET /api/ipam/prefixes/{id}/ Ipam prefixes retrieve #
PUT /api/ipam/prefixes/{id}/ Ipam prefixes update #
PATCH /api/ipam/prefixes/{id}/ Ipam prefixes partial update #
DELETE /api/ipam/prefixes/{id}/ Ipam prefixes destroy #
GET /api/ipam/prefixes/{id}/available-ips/ Ipam prefixes available ips list #
POST /api/ipam/prefixes/{id}/available-ips/ Ipam prefixes available ips create #
GET /api/ipam/prefixes/{id}/available-prefixes/ Ipam prefixes available prefixes list #
POST /api/ipam/prefixes/{id}/available-prefixes/ Ipam prefixes available prefixes create #
GET /api/ipam/rirs/ Ipam rirs list #
POST /api/ipam/rirs/ Ipam rirs create #
PUT /api/ipam/rirs/ Ipam rirs bulk update #
PATCH /api/ipam/rirs/ Ipam rirs bulk partial update #
DELETE /api/ipam/rirs/ Ipam rirs bulk destroy #
GET /api/ipam/rirs/{id}/ Ipam rirs retrieve #
PUT /api/ipam/rirs/{id}/ Ipam rirs update #
PATCH /api/ipam/rirs/{id}/ Ipam rirs partial update #
DELETE /api/ipam/rirs/{id}/ Ipam rirs destroy #
GET /api/ipam/roles/ Ipam roles list #
POST /api/ipam/roles/ Ipam roles create #
PUT /api/ipam/roles/ Ipam roles bulk update #
PATCH /api/ipam/roles/ Ipam roles bulk partial update #
DELETE /api/ipam/roles/ Ipam roles bulk destroy #
GET /api/ipam/roles/{id}/ Ipam roles retrieve #
PUT /api/ipam/roles/{id}/ Ipam roles update #
PATCH /api/ipam/roles/{id}/ Ipam roles partial update #
DELETE /api/ipam/roles/{id}/ Ipam roles destroy #
GET /api/ipam/route-targets/ Ipam route targets list #
POST /api/ipam/route-targets/ Ipam route targets create #
PUT /api/ipam/route-targets/ Ipam route targets bulk update #
PATCH /api/ipam/route-targets/ Ipam route targets bulk partial update #
DELETE /api/ipam/route-targets/ Ipam route targets bulk destroy #
GET /api/ipam/route-targets/{id}/ Ipam route targets retrieve #
PUT /api/ipam/route-targets/{id}/ Ipam route targets update #
PATCH /api/ipam/route-targets/{id}/ Ipam route targets partial update #
DELETE /api/ipam/route-targets/{id}/ Ipam route targets destroy #
GET /api/ipam/service-templates/ Ipam service templates list #
POST /api/ipam/service-templates/ Ipam service templates create #
PUT /api/ipam/service-templates/ Ipam service templates bulk update #
PATCH /api/ipam/service-templates/ Ipam service templates bulk partial update #
DELETE /api/ipam/service-templates/ Ipam service templates bulk destroy #
GET /api/ipam/service-templates/{id}/ Ipam service templates retrieve #
PUT /api/ipam/service-templates/{id}/ Ipam service templates update #
PATCH /api/ipam/service-templates/{id}/ Ipam service templates partial update #
DELETE /api/ipam/service-templates/{id}/ Ipam service templates destroy #
GET /api/ipam/services/ Ipam services list #
POST /api/ipam/services/ Ipam services create #
PUT /api/ipam/services/ Ipam services bulk update #
PATCH /api/ipam/services/ Ipam services bulk partial update #
DELETE /api/ipam/services/ Ipam services bulk destroy #
GET /api/ipam/services/{id}/ Ipam services retrieve #
PUT /api/ipam/services/{id}/ Ipam services update #
PATCH /api/ipam/services/{id}/ Ipam services partial update #
DELETE /api/ipam/services/{id}/ Ipam services destroy #
GET /api/ipam/vlan-groups/ Ipam vlan groups list #
POST /api/ipam/vlan-groups/ Ipam vlan groups create #
PUT /api/ipam/vlan-groups/ Ipam vlan groups bulk update #
PATCH /api/ipam/vlan-groups/ Ipam vlan groups bulk partial update #
DELETE /api/ipam/vlan-groups/ Ipam vlan groups bulk destroy #
GET /api/ipam/vlan-groups/{id}/ Ipam vlan groups retrieve #
PUT /api/ipam/vlan-groups/{id}/ Ipam vlan groups update #
PATCH /api/ipam/vlan-groups/{id}/ Ipam vlan groups partial update #
DELETE /api/ipam/vlan-groups/{id}/ Ipam vlan groups destroy #
GET /api/ipam/vlan-groups/{id}/available-vlans/ Ipam vlan groups available vlans list #
POST /api/ipam/vlan-groups/{id}/available-vlans/ Ipam vlan groups available vlans create #
GET /api/ipam/vlan-translation-policies/ Ipam vlan translation policies list #
POST /api/ipam/vlan-translation-policies/ Ipam vlan translation policies create #
PUT /api/ipam/vlan-translation-policies/ Ipam vlan translation policies bulk update #
PATCH /api/ipam/vlan-translation-policies/ Ipam vlan translation policies bulk partial update #
DELETE /api/ipam/vlan-translation-policies/ Ipam vlan translation policies bulk destroy #
GET /api/ipam/vlan-translation-policies/{id}/ Ipam vlan translation policies retrieve #
PUT /api/ipam/vlan-translation-policies/{id}/ Ipam vlan translation policies update #
PATCH /api/ipam/vlan-translation-policies/{id}/ Ipam vlan translation policies partial update #
DELETE /api/ipam/vlan-translation-policies/{id}/ Ipam vlan translation policies destroy #
GET /api/ipam/vlan-translation-rules/ Ipam vlan translation rules list #
POST /api/ipam/vlan-translation-rules/ Ipam vlan translation rules create #
PUT /api/ipam/vlan-translation-rules/ Ipam vlan translation rules bulk update #
PATCH /api/ipam/vlan-translation-rules/ Ipam vlan translation rules bulk partial update #
DELETE /api/ipam/vlan-translation-rules/ Ipam vlan translation rules bulk destroy #
GET /api/ipam/vlan-translation-rules/{id}/ Ipam vlan translation rules retrieve #
PUT /api/ipam/vlan-translation-rules/{id}/ Ipam vlan translation rules update #
PATCH /api/ipam/vlan-translation-rules/{id}/ Ipam vlan translation rules partial update #
DELETE /api/ipam/vlan-translation-rules/{id}/ Ipam vlan translation rules destroy #
GET /api/ipam/vlans/ Ipam vlans list #
POST /api/ipam/vlans/ Ipam vlans create #
PUT /api/ipam/vlans/ Ipam vlans bulk update #
PATCH /api/ipam/vlans/ Ipam vlans bulk partial update #
DELETE /api/ipam/vlans/ Ipam vlans bulk destroy #
GET /api/ipam/vlans/{id}/ Ipam vlans retrieve #
PUT /api/ipam/vlans/{id}/ Ipam vlans update #
PATCH /api/ipam/vlans/{id}/ Ipam vlans partial update #
DELETE /api/ipam/vlans/{id}/ Ipam vlans destroy #
GET /api/ipam/vrfs/ Ipam vrfs list #
POST /api/ipam/vrfs/ Ipam vrfs create #
PUT /api/ipam/vrfs/ Ipam vrfs bulk update #
PATCH /api/ipam/vrfs/ Ipam vrfs bulk partial update #
DELETE /api/ipam/vrfs/ Ipam vrfs bulk destroy #
GET /api/ipam/vrfs/{id}/ Ipam vrfs retrieve #
PUT /api/ipam/vrfs/{id}/ Ipam vrfs update #
PATCH /api/ipam/vrfs/{id}/ Ipam vrfs partial update #
DELETE /api/ipam/vrfs/{id}/ Ipam vrfs destroy #

Documentation

📖
Authentication
https://artifacts.apis.io/netbox-labs/authentication/netbox-labs-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/netbox-labs/openapi/netbox-labs-ipam-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/netbox-labs/errors/netbox-labs-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/netbox-labs/conventions/netbox-labs-conventions.yml
🔗
DataModel
https://artifacts.apis.io/netbox-labs/data-model/netbox-labs-data-model.yml
🔗
Conformance
https://artifacts.apis.io/netbox-labs/conformance/netbox-labs-conformance.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netbox-labs:netbox-labs-ipam-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netbox-labs-ipam-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: NetBox REST Ipam API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:


# --- truncated at 32 KB (646 KB total) ---
# Full source: https://artifacts.apis.io/netbox-labs/openapi/netbox-labs-ipam-api-openapi.yml