How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NetBox

NetBox Ipam API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Ipam API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IPAM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 172 operations across 41 paths, and defines 116 schemas. It is described by OpenAPI 3.2.0, at version 4.5.9 (4.5).

Requests are made against the base URL https://demo.netbox.dev/api.

172 operations 41 paths 116 schemas 36 DELETE41 GET36 PATCH23 POST36 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.5.9 (4.5)
Base URL
https://demo.netbox.dev/api
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox Ipam API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 172

Across 41 paths, the API surfaces 172 operations — 36 DELETE, 41 GET, 36 PATCH, 23 POST, 36 PUT. Each is listed below with its method, path, parameters, and response codes.

IPAM 172
GET
/api/ipam/aggregates/
Ipam aggregates list
ipam_aggregates_list 80 params → 200
POST
/api/ipam/aggregates/
Ipam aggregates create
ipam_aggregates_create body → 201
PUT
/api/ipam/aggregates/
Ipam aggregates bulk update
ipam_aggregates_bulk_update body → 200
PATCH
/api/ipam/aggregates/
Ipam aggregates bulk partial update
ipam_aggregates_bulk_partial_update body → 200
DELETE
/api/ipam/aggregates/
Ipam aggregates bulk destroy
ipam_aggregates_bulk_destroy body → 204
GET
/api/ipam/aggregates/{id}/
Ipam aggregates retrieve
ipam_aggregates_retrieve 1 param → 200
PUT
/api/ipam/aggregates/{id}/
Ipam aggregates update
ipam_aggregates_update 1 param body → 200
PATCH
/api/ipam/aggregates/{id}/
Ipam aggregates partial update
ipam_aggregates_partial_update 1 param body → 200
DELETE
/api/ipam/aggregates/{id}/
Ipam aggregates destroy
ipam_aggregates_destroy 1 param → 204
GET
/api/ipam/asn-ranges/
Ipam asn ranges list
ipam_asn_ranges_list 105 params → 200
POST
/api/ipam/asn-ranges/
Ipam asn ranges create
ipam_asn_ranges_create body → 201
PUT
/api/ipam/asn-ranges/
Ipam asn ranges bulk update
ipam_asn_ranges_bulk_update body → 200
PATCH
/api/ipam/asn-ranges/
Ipam asn ranges bulk partial update
ipam_asn_ranges_bulk_partial_update body → 200
DELETE
/api/ipam/asn-ranges/
Ipam asn ranges bulk destroy
ipam_asn_ranges_bulk_destroy body → 204
GET
/api/ipam/asn-ranges/{id}/
Ipam asn ranges retrieve
ipam_asn_ranges_retrieve 1 param → 200
PUT
/api/ipam/asn-ranges/{id}/
Ipam asn ranges update
ipam_asn_ranges_update 1 param body → 200
PATCH
/api/ipam/asn-ranges/{id}/
Ipam asn ranges partial update
ipam_asn_ranges_partial_update 1 param body → 200
DELETE
/api/ipam/asn-ranges/{id}/
Ipam asn ranges destroy
ipam_asn_ranges_destroy 1 param → 204
GET
/api/ipam/asn-ranges/{id}/available-asns/
Ipam asn ranges available asns list
ipam_asn_ranges_available_asns_list 1 param → 200
POST
/api/ipam/asn-ranges/{id}/available-asns/
Ipam asn ranges available asns create
ipam_asn_ranges_available_asns_create 1 param body → 201
GET
/api/ipam/asns/
Ipam asns list
ipam_asns_list 84 params → 200
POST
/api/ipam/asns/
Ipam asns create
ipam_asns_create body → 201
PUT
/api/ipam/asns/
Ipam asns bulk update
ipam_asns_bulk_update body → 200
PATCH
/api/ipam/asns/
Ipam asns bulk partial update
ipam_asns_bulk_partial_update body → 200
DELETE
/api/ipam/asns/
Ipam asns bulk destroy
ipam_asns_bulk_destroy body → 204
GET
/api/ipam/asns/{id}/
Ipam asns retrieve
ipam_asns_retrieve 1 param → 200
PUT
/api/ipam/asns/{id}/
Ipam asns update
ipam_asns_update 1 param body → 200
PATCH
/api/ipam/asns/{id}/
Ipam asns partial update
ipam_asns_partial_update 1 param body → 200
DELETE
/api/ipam/asns/{id}/
Ipam asns destroy
ipam_asns_destroy 1 param → 204
GET
/api/ipam/fhrp-group-assignments/
Ipam fhrp group assignments list
ipam_fhrp_group_assignments_list 49 params → 200
POST
/api/ipam/fhrp-group-assignments/
Ipam fhrp group assignments create
ipam_fhrp_group_assignments_create body → 201
PUT
/api/ipam/fhrp-group-assignments/
Ipam fhrp group assignments bulk update
ipam_fhrp_group_assignments_bulk_update body → 200
PATCH
/api/ipam/fhrp-group-assignments/
Ipam fhrp group assignments bulk partial update
ipam_fhrp_group_assignments_bulk_partial_update body → 200
DELETE
/api/ipam/fhrp-group-assignments/
Ipam fhrp group assignments bulk destroy
ipam_fhrp_group_assignments_bulk_destroy body → 204
GET
/api/ipam/fhrp-group-assignments/{id}/
Ipam fhrp group assignments retrieve
ipam_fhrp_group_assignments_retrieve 1 param → 200
PUT
/api/ipam/fhrp-group-assignments/{id}/
Ipam fhrp group assignments update
ipam_fhrp_group_assignments_update 1 param body → 200
PATCH
/api/ipam/fhrp-group-assignments/{id}/
Ipam fhrp group assignments partial update
ipam_fhrp_group_assignments_partial_update 1 param body → 200
DELETE
/api/ipam/fhrp-group-assignments/{id}/
Ipam fhrp group assignments destroy
ipam_fhrp_group_assignments_destroy 1 param → 204
GET
/api/ipam/fhrp-groups/
Ipam fhrp groups list
ipam_fhrp_groups_list 113 params → 200
POST
/api/ipam/fhrp-groups/
Ipam fhrp groups create
ipam_fhrp_groups_create body → 201
PUT
/api/ipam/fhrp-groups/
Ipam fhrp groups bulk update
ipam_fhrp_groups_bulk_update body → 200
PATCH
/api/ipam/fhrp-groups/
Ipam fhrp groups bulk partial update
ipam_fhrp_groups_bulk_partial_update body → 200
DELETE
/api/ipam/fhrp-groups/
Ipam fhrp groups bulk destroy
ipam_fhrp_groups_bulk_destroy body → 204
GET
/api/ipam/fhrp-groups/{id}/
Ipam fhrp groups retrieve
ipam_fhrp_groups_retrieve 1 param → 200
PUT
/api/ipam/fhrp-groups/{id}/
Ipam fhrp groups update
ipam_fhrp_groups_update 1 param body → 200
PATCH
/api/ipam/fhrp-groups/{id}/
Ipam fhrp groups partial update
ipam_fhrp_groups_partial_update 1 param body → 200
DELETE
/api/ipam/fhrp-groups/{id}/
Ipam fhrp groups destroy
ipam_fhrp_groups_destroy 1 param → 204
GET
/api/ipam/ip-addresses/
Ipam ip addresses list
ipam_ip_addresses_list 147 params → 200
POST
/api/ipam/ip-addresses/
Ipam ip addresses create
ipam_ip_addresses_create body → 201
PUT
/api/ipam/ip-addresses/
Ipam ip addresses bulk update
ipam_ip_addresses_bulk_update body → 200
PATCH
/api/ipam/ip-addresses/
Ipam ip addresses bulk partial update
ipam_ip_addresses_bulk_partial_update body → 200
DELETE
/api/ipam/ip-addresses/
Ipam ip addresses bulk destroy
ipam_ip_addresses_bulk_destroy body → 204
GET
/api/ipam/ip-addresses/{id}/
Ipam ip addresses retrieve
ipam_ip_addresses_retrieve 1 param → 200
PUT
/api/ipam/ip-addresses/{id}/
Ipam ip addresses update
ipam_ip_addresses_update 1 param body → 200
PATCH
/api/ipam/ip-addresses/{id}/
Ipam ip addresses partial update
ipam_ip_addresses_partial_update 1 param body → 200
DELETE
/api/ipam/ip-addresses/{id}/
Ipam ip addresses destroy
ipam_ip_addresses_destroy 1 param → 204
GET
/api/ipam/ip-ranges/
Ipam ip ranges list
ipam_ip_ranges_list 102 params → 200
POST
/api/ipam/ip-ranges/
Ipam ip ranges create
ipam_ip_ranges_create body → 201
PUT
/api/ipam/ip-ranges/
Ipam ip ranges bulk update
ipam_ip_ranges_bulk_update body → 200
PATCH
/api/ipam/ip-ranges/
Ipam ip ranges bulk partial update
ipam_ip_ranges_bulk_partial_update body → 200
DELETE
/api/ipam/ip-ranges/
Ipam ip ranges bulk destroy
ipam_ip_ranges_bulk_destroy body → 204
GET
/api/ipam/ip-ranges/{id}/
Ipam ip ranges retrieve
ipam_ip_ranges_retrieve 1 param → 200
PUT
/api/ipam/ip-ranges/{id}/
Ipam ip ranges update
ipam_ip_ranges_update 1 param body → 200
PATCH
/api/ipam/ip-ranges/{id}/
Ipam ip ranges partial update
ipam_ip_ranges_partial_update 1 param body → 200
DELETE
/api/ipam/ip-ranges/{id}/
Ipam ip ranges destroy
ipam_ip_ranges_destroy 1 param → 204
GET
/api/ipam/ip-ranges/{id}/available-ips/
Ipam ip ranges available ips list
ipam_ip_ranges_available_ips_list 1 param → 200
POST
/api/ipam/ip-ranges/{id}/available-ips/
Ipam ip ranges available ips create
ipam_ip_ranges_available_ips_create 1 param body → 201
GET
/api/ipam/prefixes/
Ipam prefixes list
ipam_prefixes_list 152 params → 200
POST
/api/ipam/prefixes/
Ipam prefixes create
ipam_prefixes_create body → 201
PUT
/api/ipam/prefixes/
Ipam prefixes bulk update
ipam_prefixes_bulk_update body → 200
PATCH
/api/ipam/prefixes/
Ipam prefixes bulk partial update
ipam_prefixes_bulk_partial_update body → 200
DELETE
/api/ipam/prefixes/
Ipam prefixes bulk destroy
ipam_prefixes_bulk_destroy body → 204
GET
/api/ipam/prefixes/{id}/
Ipam prefixes retrieve
ipam_prefixes_retrieve 1 param → 200
PUT
/api/ipam/prefixes/{id}/
Ipam prefixes update
ipam_prefixes_update 1 param body → 200
PATCH
/api/ipam/prefixes/{id}/
Ipam prefixes partial update
ipam_prefixes_partial_update 1 param body → 200
DELETE
/api/ipam/prefixes/{id}/
Ipam prefixes destroy
ipam_prefixes_destroy 1 param → 204
GET
/api/ipam/prefixes/{id}/available-ips/
Ipam prefixes available ips list
ipam_prefixes_available_ips_list 1 param → 200
POST
/api/ipam/prefixes/{id}/available-ips/
Ipam prefixes available ips create
ipam_prefixes_available_ips_create 1 param body → 201
GET
/api/ipam/prefixes/{id}/available-prefixes/
Ipam prefixes available prefixes list
ipam_prefixes_available_prefixes_list 1 param → 200
POST
/api/ipam/prefixes/{id}/available-prefixes/
Ipam prefixes available prefixes create
ipam_prefixes_available_prefixes_create 1 param body → 201
GET
/api/ipam/rirs/
Ipam rirs list
ipam_rirs_list 80 params → 200
POST
/api/ipam/rirs/
Ipam rirs create
ipam_rirs_create body → 201
PUT
/api/ipam/rirs/
Ipam rirs bulk update
ipam_rirs_bulk_update body → 200
PATCH
/api/ipam/rirs/
Ipam rirs bulk partial update
ipam_rirs_bulk_partial_update body → 200
DELETE
/api/ipam/rirs/
Ipam rirs bulk destroy
ipam_rirs_bulk_destroy body → 204
GET
/api/ipam/rirs/{id}/
Ipam rirs retrieve
ipam_rirs_retrieve 1 param → 200
PUT
/api/ipam/rirs/{id}/
Ipam rirs update
ipam_rirs_update 1 param body → 200
PATCH
/api/ipam/rirs/{id}/
Ipam rirs partial update
ipam_rirs_partial_update 1 param body → 200
DELETE
/api/ipam/rirs/{id}/
Ipam rirs destroy
ipam_rirs_destroy 1 param → 204
GET
/api/ipam/roles/
Ipam roles list
ipam_roles_list 86 params → 200
POST
/api/ipam/roles/
Ipam roles create
ipam_roles_create body → 201
PUT
/api/ipam/roles/
Ipam roles bulk update
ipam_roles_bulk_update body → 200
PATCH
/api/ipam/roles/
Ipam roles bulk partial update
ipam_roles_bulk_partial_update body → 200
DELETE
/api/ipam/roles/
Ipam roles bulk destroy
ipam_roles_bulk_destroy body → 204
GET
/api/ipam/roles/{id}/
Ipam roles retrieve
ipam_roles_retrieve 1 param → 200
PUT
/api/ipam/roles/{id}/
Ipam roles update
ipam_roles_update 1 param body → 200
PATCH
/api/ipam/roles/{id}/
Ipam roles partial update
ipam_roles_partial_update 1 param body → 200
DELETE
/api/ipam/roles/{id}/
Ipam roles destroy
ipam_roles_destroy 1 param → 204
GET
/api/ipam/route-targets/
Ipam route targets list
ipam_route_targets_list 90 params → 200
POST
/api/ipam/route-targets/
Ipam route targets create
ipam_route_targets_create body → 201
PUT
/api/ipam/route-targets/
Ipam route targets bulk update
ipam_route_targets_bulk_update body → 200
PATCH
/api/ipam/route-targets/
Ipam route targets bulk partial update
ipam_route_targets_bulk_partial_update body → 200
DELETE
/api/ipam/route-targets/
Ipam route targets bulk destroy
ipam_route_targets_bulk_destroy body → 204
GET
/api/ipam/route-targets/{id}/
Ipam route targets retrieve
ipam_route_targets_retrieve 1 param → 200
PUT
/api/ipam/route-targets/{id}/
Ipam route targets update
ipam_route_targets_update 1 param body → 200
PATCH
/api/ipam/route-targets/{id}/
Ipam route targets partial update
ipam_route_targets_partial_update 1 param body → 200
DELETE
/api/ipam/route-targets/{id}/
Ipam route targets destroy
ipam_route_targets_destroy 1 param → 204
GET
/api/ipam/service-templates/
Ipam service templates list
ipam_service_templates_list 86 params → 200
POST
/api/ipam/service-templates/
Ipam service templates create
ipam_service_templates_create body → 201
PUT
/api/ipam/service-templates/
Ipam service templates bulk update
ipam_service_templates_bulk_update body → 200
PATCH
/api/ipam/service-templates/
Ipam service templates bulk partial update
ipam_service_templates_bulk_partial_update body → 200
DELETE
/api/ipam/service-templates/
Ipam service templates bulk destroy
ipam_service_templates_bulk_destroy body → 204
GET
/api/ipam/service-templates/{id}/
Ipam service templates retrieve
ipam_service_templates_retrieve 1 param → 200
PUT
/api/ipam/service-templates/{id}/
Ipam service templates update
ipam_service_templates_update 1 param body → 200
PATCH
/api/ipam/service-templates/{id}/
Ipam service templates partial update
ipam_service_templates_partial_update 1 param body → 200
DELETE
/api/ipam/service-templates/{id}/
Ipam service templates destroy
ipam_service_templates_destroy 1 param → 204
GET
/api/ipam/services/
Ipam services list
ipam_services_list 111 params → 200
POST
/api/ipam/services/
Ipam services create
ipam_services_create body → 201
PUT
/api/ipam/services/
Ipam services bulk update
ipam_services_bulk_update body → 200
PATCH
/api/ipam/services/
Ipam services bulk partial update
ipam_services_bulk_partial_update body → 200
DELETE
/api/ipam/services/
Ipam services bulk destroy
ipam_services_bulk_destroy body → 204
GET
/api/ipam/services/{id}/
Ipam services retrieve
ipam_services_retrieve 1 param → 200
PUT
/api/ipam/services/{id}/
Ipam services update
ipam_services_update 1 param body → 200
PATCH
/api/ipam/services/{id}/
Ipam services partial update
ipam_services_partial_update 1 param body → 200
DELETE
/api/ipam/services/{id}/
Ipam services destroy
ipam_services_destroy 1 param → 204
GET
/api/ipam/vlan-groups/
Ipam vlan groups list
ipam_vlan_groups_list 104 params → 200
POST
/api/ipam/vlan-groups/
Ipam vlan groups create
ipam_vlan_groups_create body → 201
PUT
/api/ipam/vlan-groups/
Ipam vlan groups bulk update
ipam_vlan_groups_bulk_update body → 200
PATCH
/api/ipam/vlan-groups/
Ipam vlan groups bulk partial update
ipam_vlan_groups_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-groups/
Ipam vlan groups bulk destroy
ipam_vlan_groups_bulk_destroy body → 204
GET
/api/ipam/vlan-groups/{id}/
Ipam vlan groups retrieve
ipam_vlan_groups_retrieve 1 param → 200
PUT
/api/ipam/vlan-groups/{id}/
Ipam vlan groups update
ipam_vlan_groups_update 1 param body → 200
PATCH
/api/ipam/vlan-groups/{id}/
Ipam vlan groups partial update
ipam_vlan_groups_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-groups/{id}/
Ipam vlan groups destroy
ipam_vlan_groups_destroy 1 param → 204
GET
/api/ipam/vlan-groups/{id}/available-vlans/
Ipam vlan groups available vlans list
ipam_vlan_groups_available_vlans_list 1 param → 200
POST
/api/ipam/vlan-groups/{id}/available-vlans/
Ipam vlan groups available vlans create
ipam_vlan_groups_available_vlans_create 1 param body → 201
GET
/api/ipam/vlan-translation-policies/
Ipam vlan translation policies list
ipam_vlan_translation_policies_list 66 params → 200
POST
/api/ipam/vlan-translation-policies/
Ipam vlan translation policies create
ipam_vlan_translation_policies_create body → 201
PUT
/api/ipam/vlan-translation-policies/
Ipam vlan translation policies bulk update
ipam_vlan_translation_policies_bulk_update body → 200
PATCH
/api/ipam/vlan-translation-policies/
Ipam vlan translation policies bulk partial update
ipam_vlan_translation_policies_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-translation-policies/
Ipam vlan translation policies bulk destroy
ipam_vlan_translation_policies_bulk_destroy body → 204
GET
/api/ipam/vlan-translation-policies/{id}/
Ipam vlan translation policies retrieve
ipam_vlan_translation_policies_retrieve 1 param → 200
PUT
/api/ipam/vlan-translation-policies/{id}/
Ipam vlan translation policies update
ipam_vlan_translation_policies_update 1 param body → 200
PATCH
/api/ipam/vlan-translation-policies/{id}/
Ipam vlan translation policies partial update
ipam_vlan_translation_policies_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-translation-policies/{id}/
Ipam vlan translation policies destroy
ipam_vlan_translation_policies_destroy 1 param → 204
GET
/api/ipam/vlan-translation-rules/
Ipam vlan translation rules list
ipam_vlan_translation_rules_list 63 params → 200
POST
/api/ipam/vlan-translation-rules/
Ipam vlan translation rules create
ipam_vlan_translation_rules_create body → 201
PUT
/api/ipam/vlan-translation-rules/
Ipam vlan translation rules bulk update
ipam_vlan_translation_rules_bulk_update body → 200
PATCH
/api/ipam/vlan-translation-rules/
Ipam vlan translation rules bulk partial update
ipam_vlan_translation_rules_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-translation-rules/
Ipam vlan translation rules bulk destroy
ipam_vlan_translation_rules_bulk_destroy body → 204
GET
/api/ipam/vlan-translation-rules/{id}/
Ipam vlan translation rules retrieve
ipam_vlan_translation_rules_retrieve 1 param → 200
PUT
/api/ipam/vlan-translation-rules/{id}/
Ipam vlan translation rules update
ipam_vlan_translation_rules_update 1 param body → 200
PATCH
/api/ipam/vlan-translation-rules/{id}/
Ipam vlan translation rules partial update
ipam_vlan_translation_rules_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-translation-rules/{id}/
Ipam vlan translation rules destroy
ipam_vlan_translation_rules_destroy 1 param → 204
GET
/api/ipam/vlans/
Ipam vlans list
ipam_vlans_list 145 params → 200
POST
/api/ipam/vlans/
Ipam vlans create
ipam_vlans_create body → 201
PUT
/api/ipam/vlans/
Ipam vlans bulk update
ipam_vlans_bulk_update body → 200
PATCH
/api/ipam/vlans/
Ipam vlans bulk partial update
ipam_vlans_bulk_partial_update body → 200
DELETE
/api/ipam/vlans/
Ipam vlans bulk destroy
ipam_vlans_bulk_destroy body → 204
GET
/api/ipam/vlans/{id}/
Ipam vlans retrieve
ipam_vlans_retrieve 1 param → 200
PUT
/api/ipam/vlans/{id}/
Ipam vlans update
ipam_vlans_update 1 param body → 200
PATCH
/api/ipam/vlans/{id}/
Ipam vlans partial update
ipam_vlans_partial_update 1 param body → 200
DELETE
/api/ipam/vlans/{id}/
Ipam vlans destroy
ipam_vlans_destroy 1 param → 204
GET
/api/ipam/vrfs/
Ipam vrfs list
ipam_vrfs_list 96 params → 200
POST
/api/ipam/vrfs/
Ipam vrfs create
ipam_vrfs_create body → 201
PUT
/api/ipam/vrfs/
Ipam vrfs bulk update
ipam_vrfs_bulk_update body → 200
PATCH
/api/ipam/vrfs/
Ipam vrfs bulk partial update
ipam_vrfs_bulk_partial_update body → 200
DELETE
/api/ipam/vrfs/
Ipam vrfs bulk destroy
ipam_vrfs_bulk_destroy body → 204
GET
/api/ipam/vrfs/{id}/
Ipam vrfs retrieve
ipam_vrfs_retrieve 1 param → 200
PUT
/api/ipam/vrfs/{id}/
Ipam vrfs update
ipam_vrfs_update 1 param body → 200
PATCH
/api/ipam/vrfs/{id}/
Ipam vrfs partial update
ipam_vrfs_partial_update 1 param body → 200
DELETE
/api/ipam/vrfs/{id}/
Ipam vrfs destroy
ipam_vrfs_destroy 1 param → 204

Schemas 116

The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are Prefix (25 properties), IPAddress (23 properties), VLAN (22 properties), IPRange (21 properties). Each schema is shown below with its type and property counts.

BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PaginatedFHRPGroupList
object
4 properties 2 required
PatchedVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
PaginatedVRFList
object
4 properties 2 required
PaginatedASNList
object
4 properties 2 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
WritablePrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
CreateAvailableVLANRequest
object
Adds support for custom fields and tags.
8 properties 1 required
PaginatedServiceTemplateList
object
4 properties 2 required
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
PatchedVLANTranslationRuleRequest
object
Adds support for custom fields and tags.
4 properties
PatchedWritableVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
PatchedRouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
FHRPGroupAssignment
object
Adds support for custom fields and tags.
10 properties 10 required
AvailableASN
object
Representation of an ASN which does not exist in the database.
2 properties 1 required
IntegerRange
array
RIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
NestedVLANRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
PaginatedServiceList
object
4 properties 2 required
ASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties 5 required
BriefFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
IPAddress
object
Base serializer class for models inheriting from PrimaryModel.
23 properties 10 required
PatchedRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
NestedTag
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 6 required
RoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
PaginatedRoleList
object
4 properties 2 required
ASNSite
object
This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.
6 properties 5 required
VRF
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 9 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 7 required
WritableIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 required
NestedIPAddressRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
1 property 1 required
PatchedFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PaginatedRIRList
object
4 properties 2 required
BriefVLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
Service
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 11 required
NestedIPAddress
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 6 required
WritableIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
VLANTranslationRule
object
Adds support for custom fields and tags.
7 properties 6 required
PatchedWritableAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
ASN
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
FHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
4 properties 4 required
ServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
VLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
20 properties 11 required
PatchedFHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
4 properties
FHRPGroup
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
PaginatedVLANTranslationPolicyList
object
4 properties 2 required
PatchedVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
PatchedRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
WritableVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 2 required
BriefRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
WritableServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 3 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
VLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
PatchedWritableServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
ASNRange
object
Base serializer class for models inheriting from OrganizationalModel.
18 properties 12 required
IntegerRangeRequest
array
PaginatedRouteTargetList
object
4 properties 2 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
RouteTarget
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
PaginatedIPRangeList
object
4 properties 2 required
WritableServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 5 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 5 required
BriefFHRPGroup
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritableIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
PaginatedFHRPGroupAssignmentList
object
4 properties 2 required
PatchedASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
VLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 2 required
VLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties 2 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
IPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
PatchedASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties
PaginatedVLANGroupList
object
4 properties 2 required
AvailableIP
object
Representation of an IP address which does not exist in the database.
4 properties 3 required
WritableAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
PatchedWritableIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
PaginatedVLANTranslationRuleList
object
4 properties 2 required
ServiceTemplate
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 8 required
PatchedVLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties
ASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
NestedVLAN
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
6 properties 5 required
Prefix
object
Base serializer class for models inheriting from PrimaryModel.
25 properties 11 required
VLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 1 required
PatchedWritablePrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PaginatedIPAddressList
object
4 properties 2 required
AggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
PaginatedAggregateList
object
4 properties 2 required
RIR
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
RouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 1 required
PaginatedVLANList
object
4 properties 2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
AvailableIPRequestRequest
object
Request payload for creating IP addresses from the available-ips endpoint.
1 property
Role
object
Base serializer class for models inheriting from OrganizationalModel.
16 properties 10 required
Aggregate
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
FHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
ServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 10 required
IPRange
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 10 required
AvailableVLAN
object
Representation of a VLAN which does not exist in the database.
2 properties 2 required
AvailablePrefix
object
Representation of a prefix which does not exist in the database.
3 properties 3 required
PaginatedPrefixList
object
4 properties 2 required
PaginatedASNRangeList
object
4 properties 2 required
IPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 required
BriefRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
VLANTranslationRuleRequest
object
Adds support for custom fields and tags.
4 properties 3 required
PatchedWritableServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
VRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
PrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
BriefL2VPNTermination
object
Adds support for custom fields and tags.
4 properties 4 required
PrefixLengthRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-ipam-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
AE Profile APIs.io
NetBox Authentication Check API
AE Profile APIs.io
NetBox Circuits API
AE Profile APIs.io
NetBox Core API
AE Profile APIs.io
NetBox Dcim API
AE Profile APIs.io
NetBox Extras API
AE Profile APIs.io
NetBox Schema API
AE Profile APIs.io
NetBox Status API
AE Profile APIs.io
NetBox Tenancy API
AE Profile APIs.io
NetBox Users API
AE Profile APIs.io
NetBox Virtualization API
AE Profile APIs.io
NetBox Vpn API
AE Profile APIs.io
#IPAM
← Back to N APIs
API Details
ID
netbox:netbox-ipam-api
Base URL
https://demo.netbox.dev/api
Docs
https://docs.netbox.dev/en/stable/
Provider
NetBox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbox-ipam-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-ipam-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of NetBox Ipam API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.