Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox Labs

NetBox Labs ipam API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Labs ipam API is one of 13 APIs that NetBox Labs 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 and authentication docs.

This API exposes 172 operations across 41 paths, and defines 152 schemas. It is described by OpenAPI 3.0.3, at version 4.6.5 (4.6).

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

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

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

NetBox Labs 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/
Get a list of aggregate objects.
ipam_aggregates_list 84 params → 200
POST
/api/ipam/aggregates/
Post a list of aggregate objects.
ipam_aggregates_create body → 201
PUT
/api/ipam/aggregates/
Put a list of aggregate objects.
ipam_aggregates_bulk_update body → 200
PATCH
/api/ipam/aggregates/
Patch a list of aggregate objects.
ipam_aggregates_bulk_partial_update body → 200
DELETE
/api/ipam/aggregates/
Delete a list of aggregate objects.
ipam_aggregates_bulk_destroy body → 204
GET
/api/ipam/aggregates/{id}/
Get a aggregate object.
ipam_aggregates_retrieve 4 params → 200
PUT
/api/ipam/aggregates/{id}/
Put a aggregate object.
ipam_aggregates_update 1 param body → 200
PATCH
/api/ipam/aggregates/{id}/
Patch a aggregate object.
ipam_aggregates_partial_update 1 param body → 200
DELETE
/api/ipam/aggregates/{id}/
Delete a aggregate object.
ipam_aggregates_destroy 1 param → 204
GET
/api/ipam/asn-ranges/
Get a list of ASN range objects.
ipam_asn_ranges_list 108 params → 200
POST
/api/ipam/asn-ranges/
Post a list of ASN range objects.
ipam_asn_ranges_create body → 201
PUT
/api/ipam/asn-ranges/
Put a list of ASN range objects.
ipam_asn_ranges_bulk_update body → 200
PATCH
/api/ipam/asn-ranges/
Patch a list of ASN range objects.
ipam_asn_ranges_bulk_partial_update body → 200
DELETE
/api/ipam/asn-ranges/
Delete a list of ASN range objects.
ipam_asn_ranges_bulk_destroy body → 204
GET
/api/ipam/asn-ranges/{id}/
Get a ASN range object.
ipam_asn_ranges_retrieve 4 params → 200
PUT
/api/ipam/asn-ranges/{id}/
Put a ASN range object.
ipam_asn_ranges_update 1 param body → 200
PATCH
/api/ipam/asn-ranges/{id}/
Patch a ASN range object.
ipam_asn_ranges_partial_update 1 param body → 200
DELETE
/api/ipam/asn-ranges/{id}/
Delete a ASN range object.
ipam_asn_ranges_destroy 1 param → 204
GET
/api/ipam/asn-ranges/{id}/available-asns/
Get a ASN object.
ipam_asn_ranges_available_asns_list 4 params → 200
POST
/api/ipam/asn-ranges/{id}/available-asns/
Post a ASN object.
ipam_asn_ranges_available_asns_create 1 param body → 201
GET
/api/ipam/asns/
Get a list of ASN objects.
ipam_asns_list 92 params → 200
POST
/api/ipam/asns/
Post a list of ASN objects.
ipam_asns_create body → 201
PUT
/api/ipam/asns/
Put a list of ASN objects.
ipam_asns_bulk_update body → 200
PATCH
/api/ipam/asns/
Patch a list of ASN objects.
ipam_asns_bulk_partial_update body → 200
DELETE
/api/ipam/asns/
Delete a list of ASN objects.
ipam_asns_bulk_destroy body → 204
GET
/api/ipam/asns/{id}/
Get a ASN object.
ipam_asns_retrieve 4 params → 200
PUT
/api/ipam/asns/{id}/
Put a ASN object.
ipam_asns_update 1 param body → 200
PATCH
/api/ipam/asns/{id}/
Patch a ASN object.
ipam_asns_partial_update 1 param body → 200
DELETE
/api/ipam/asns/{id}/
Delete a ASN object.
ipam_asns_destroy 1 param → 204
GET
/api/ipam/fhrp-group-assignments/
Get a list of FHRP group assignment objects.
ipam_fhrp_group_assignments_list 53 params → 200
POST
/api/ipam/fhrp-group-assignments/
Post a list of FHRP group assignment objects.
ipam_fhrp_group_assignments_create body → 201
PUT
/api/ipam/fhrp-group-assignments/
Put a list of FHRP group assignment objects.
ipam_fhrp_group_assignments_bulk_update body → 200
PATCH
/api/ipam/fhrp-group-assignments/
Patch a list of FHRP group assignment objects.
ipam_fhrp_group_assignments_bulk_partial_update body → 200
DELETE
/api/ipam/fhrp-group-assignments/
Delete a list of FHRP group assignment objects.
ipam_fhrp_group_assignments_bulk_destroy body → 204
GET
/api/ipam/fhrp-group-assignments/{id}/
Get a FHRP group assignment object.
ipam_fhrp_group_assignments_retrieve 4 params → 200
PUT
/api/ipam/fhrp-group-assignments/{id}/
Put a FHRP group assignment object.
ipam_fhrp_group_assignments_update 1 param body → 200
PATCH
/api/ipam/fhrp-group-assignments/{id}/
Patch a FHRP group assignment object.
ipam_fhrp_group_assignments_partial_update 1 param body → 200
DELETE
/api/ipam/fhrp-group-assignments/{id}/
Delete a FHRP group assignment object.
ipam_fhrp_group_assignments_destroy 1 param → 204
GET
/api/ipam/fhrp-groups/
Get a list of FHRP group objects.
ipam_fhrp_groups_list 117 params → 200
POST
/api/ipam/fhrp-groups/
Post a list of FHRP group objects.
ipam_fhrp_groups_create body → 201
PUT
/api/ipam/fhrp-groups/
Put a list of FHRP group objects.
ipam_fhrp_groups_bulk_update body → 200
PATCH
/api/ipam/fhrp-groups/
Patch a list of FHRP group objects.
ipam_fhrp_groups_bulk_partial_update body → 200
DELETE
/api/ipam/fhrp-groups/
Delete a list of FHRP group objects.
ipam_fhrp_groups_bulk_destroy body → 204
GET
/api/ipam/fhrp-groups/{id}/
Get a FHRP group object.
ipam_fhrp_groups_retrieve 4 params → 200
PUT
/api/ipam/fhrp-groups/{id}/
Put a FHRP group object.
ipam_fhrp_groups_update 1 param body → 200
PATCH
/api/ipam/fhrp-groups/{id}/
Patch a FHRP group object.
ipam_fhrp_groups_partial_update 1 param body → 200
DELETE
/api/ipam/fhrp-groups/{id}/
Delete a FHRP group object.
ipam_fhrp_groups_destroy 1 param → 204
GET
/api/ipam/ip-addresses/
Get a list of IP address objects.
ipam_ip_addresses_list 151 params → 200
POST
/api/ipam/ip-addresses/
Post a list of IP address objects.
ipam_ip_addresses_create body → 201
PUT
/api/ipam/ip-addresses/
Put a list of IP address objects.
ipam_ip_addresses_bulk_update body → 200
PATCH
/api/ipam/ip-addresses/
Patch a list of IP address objects.
ipam_ip_addresses_bulk_partial_update body → 200
DELETE
/api/ipam/ip-addresses/
Delete a list of IP address objects.
ipam_ip_addresses_bulk_destroy body → 204
GET
/api/ipam/ip-addresses/{id}/
Get a IP address object.
ipam_ip_addresses_retrieve 4 params → 200
PUT
/api/ipam/ip-addresses/{id}/
Put a IP address object.
ipam_ip_addresses_update 1 param body → 200
PATCH
/api/ipam/ip-addresses/{id}/
Patch a IP address object.
ipam_ip_addresses_partial_update 1 param body → 200
DELETE
/api/ipam/ip-addresses/{id}/
Delete a IP address object.
ipam_ip_addresses_destroy 1 param → 204
GET
/api/ipam/ip-ranges/
Get a list of IP range objects.
ipam_ip_ranges_list 106 params → 200
POST
/api/ipam/ip-ranges/
Post a list of IP range objects.
ipam_ip_ranges_create body → 201
PUT
/api/ipam/ip-ranges/
Put a list of IP range objects.
ipam_ip_ranges_bulk_update body → 200
PATCH
/api/ipam/ip-ranges/
Patch a list of IP range objects.
ipam_ip_ranges_bulk_partial_update body → 200
DELETE
/api/ipam/ip-ranges/
Delete a list of IP range objects.
ipam_ip_ranges_bulk_destroy body → 204
GET
/api/ipam/ip-ranges/{id}/
Get a IP range object.
ipam_ip_ranges_retrieve 4 params → 200
PUT
/api/ipam/ip-ranges/{id}/
Put a IP range object.
ipam_ip_ranges_update 1 param body → 200
PATCH
/api/ipam/ip-ranges/{id}/
Patch a IP range object.
ipam_ip_ranges_partial_update 1 param body → 200
DELETE
/api/ipam/ip-ranges/{id}/
Delete a IP range object.
ipam_ip_ranges_destroy 1 param → 204
GET
/api/ipam/ip-ranges/{id}/available-ips/
Get a IP address object.
ipam_ip_ranges_available_ips_list 4 params → 200
POST
/api/ipam/ip-ranges/{id}/available-ips/
Post a IP address object.
ipam_ip_ranges_available_ips_create 1 param body → 201
GET
/api/ipam/prefixes/
Get a list of prefix objects.
ipam_prefixes_list 156 params → 200
POST
/api/ipam/prefixes/
Post a list of prefix objects.
ipam_prefixes_create body → 201
PUT
/api/ipam/prefixes/
Put a list of prefix objects.
ipam_prefixes_bulk_update body → 200
PATCH
/api/ipam/prefixes/
Patch a list of prefix objects.
ipam_prefixes_bulk_partial_update body → 200
DELETE
/api/ipam/prefixes/
Delete a list of prefix objects.
ipam_prefixes_bulk_destroy body → 204
GET
/api/ipam/prefixes/{id}/
Get a prefix object.
ipam_prefixes_retrieve 4 params → 200
PUT
/api/ipam/prefixes/{id}/
Put a prefix object.
ipam_prefixes_update 1 param body → 200
PATCH
/api/ipam/prefixes/{id}/
Patch a prefix object.
ipam_prefixes_partial_update 1 param body → 200
DELETE
/api/ipam/prefixes/{id}/
Delete a prefix object.
ipam_prefixes_destroy 1 param → 204
GET
/api/ipam/prefixes/{id}/available-ips/
Get a IP address object.
ipam_prefixes_available_ips_list 4 params → 200
POST
/api/ipam/prefixes/{id}/available-ips/
Post a IP address object.
ipam_prefixes_available_ips_create 1 param body → 201
GET
/api/ipam/prefixes/{id}/available-prefixes/
Get a prefix object.
ipam_prefixes_available_prefixes_list 4 params → 200
POST
/api/ipam/prefixes/{id}/available-prefixes/
Post a prefix object.
ipam_prefixes_available_prefixes_create 1 param body → 201
GET
/api/ipam/rirs/
Get a list of RIR objects.
ipam_rirs_list 84 params → 200
POST
/api/ipam/rirs/
Post a list of RIR objects.
ipam_rirs_create body → 201
PUT
/api/ipam/rirs/
Put a list of RIR objects.
ipam_rirs_bulk_update body → 200
PATCH
/api/ipam/rirs/
Patch a list of RIR objects.
ipam_rirs_bulk_partial_update body → 200
DELETE
/api/ipam/rirs/
Delete a list of RIR objects.
ipam_rirs_bulk_destroy body → 204
GET
/api/ipam/rirs/{id}/
Get a RIR object.
ipam_rirs_retrieve 4 params → 200
PUT
/api/ipam/rirs/{id}/
Put a RIR object.
ipam_rirs_update 1 param body → 200
PATCH
/api/ipam/rirs/{id}/
Patch a RIR object.
ipam_rirs_partial_update 1 param body → 200
DELETE
/api/ipam/rirs/{id}/
Delete a RIR object.
ipam_rirs_destroy 1 param → 204
GET
/api/ipam/roles/
Get a list of role objects.
ipam_roles_list 90 params → 200
POST
/api/ipam/roles/
Post a list of role objects.
ipam_roles_create body → 201
PUT
/api/ipam/roles/
Put a list of role objects.
ipam_roles_bulk_update body → 200
PATCH
/api/ipam/roles/
Patch a list of role objects.
ipam_roles_bulk_partial_update body → 200
DELETE
/api/ipam/roles/
Delete a list of role objects.
ipam_roles_bulk_destroy body → 204
GET
/api/ipam/roles/{id}/
Get a role object.
ipam_roles_retrieve 4 params → 200
PUT
/api/ipam/roles/{id}/
Put a role object.
ipam_roles_update 1 param body → 200
PATCH
/api/ipam/roles/{id}/
Patch a role object.
ipam_roles_partial_update 1 param body → 200
DELETE
/api/ipam/roles/{id}/
Delete a role object.
ipam_roles_destroy 1 param → 204
GET
/api/ipam/route-targets/
Get a list of route target objects.
ipam_route_targets_list 94 params → 200
POST
/api/ipam/route-targets/
Post a list of route target objects.
ipam_route_targets_create body → 201
PUT
/api/ipam/route-targets/
Put a list of route target objects.
ipam_route_targets_bulk_update body → 200
PATCH
/api/ipam/route-targets/
Patch a list of route target objects.
ipam_route_targets_bulk_partial_update body → 200
DELETE
/api/ipam/route-targets/
Delete a list of route target objects.
ipam_route_targets_bulk_destroy body → 204
GET
/api/ipam/route-targets/{id}/
Get a route target object.
ipam_route_targets_retrieve 4 params → 200
PUT
/api/ipam/route-targets/{id}/
Put a route target object.
ipam_route_targets_update 1 param body → 200
PATCH
/api/ipam/route-targets/{id}/
Patch a route target object.
ipam_route_targets_partial_update 1 param body → 200
DELETE
/api/ipam/route-targets/{id}/
Delete a route target object.
ipam_route_targets_destroy 1 param → 204
GET
/api/ipam/service-templates/
Get a list of application service template objects.
ipam_service_templates_list 90 params → 200
POST
/api/ipam/service-templates/
Post a list of application service template objects.
ipam_service_templates_create body → 201
PUT
/api/ipam/service-templates/
Put a list of application service template objects.
ipam_service_templates_bulk_update body → 200
PATCH
/api/ipam/service-templates/
Patch a list of application service template objects.
ipam_service_templates_bulk_partial_update body → 200
DELETE
/api/ipam/service-templates/
Delete a list of application service template objects.
ipam_service_templates_bulk_destroy body → 204
GET
/api/ipam/service-templates/{id}/
Get a application service template object.
ipam_service_templates_retrieve 4 params → 200
PUT
/api/ipam/service-templates/{id}/
Put a application service template object.
ipam_service_templates_update 1 param body → 200
PATCH
/api/ipam/service-templates/{id}/
Patch a application service template object.
ipam_service_templates_partial_update 1 param body → 200
DELETE
/api/ipam/service-templates/{id}/
Delete a application service template object.
ipam_service_templates_destroy 1 param → 204
GET
/api/ipam/services/
Get a list of application service objects.
ipam_services_list 115 params → 200
POST
/api/ipam/services/
Post a list of application service objects.
ipam_services_create body → 201
PUT
/api/ipam/services/
Put a list of application service objects.
ipam_services_bulk_update body → 200
PATCH
/api/ipam/services/
Patch a list of application service objects.
ipam_services_bulk_partial_update body → 200
DELETE
/api/ipam/services/
Delete a list of application service objects.
ipam_services_bulk_destroy body → 204
GET
/api/ipam/services/{id}/
Get a application service object.
ipam_services_retrieve 4 params → 200
PUT
/api/ipam/services/{id}/
Put a application service object.
ipam_services_update 1 param body → 200
PATCH
/api/ipam/services/{id}/
Patch a application service object.
ipam_services_partial_update 1 param body → 200
DELETE
/api/ipam/services/{id}/
Delete a application service object.
ipam_services_destroy 1 param → 204
GET
/api/ipam/vlan-groups/
Get a list of VLAN group objects.
ipam_vlan_groups_list 116 params → 200
POST
/api/ipam/vlan-groups/
Post a list of VLAN group objects.
ipam_vlan_groups_create body → 201
PUT
/api/ipam/vlan-groups/
Put a list of VLAN group objects.
ipam_vlan_groups_bulk_update body → 200
PATCH
/api/ipam/vlan-groups/
Patch a list of VLAN group objects.
ipam_vlan_groups_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-groups/
Delete a list of VLAN group objects.
ipam_vlan_groups_bulk_destroy body → 204
GET
/api/ipam/vlan-groups/{id}/
Get a VLAN group object.
ipam_vlan_groups_retrieve 4 params → 200
PUT
/api/ipam/vlan-groups/{id}/
Put a VLAN group object.
ipam_vlan_groups_update 1 param body → 200
PATCH
/api/ipam/vlan-groups/{id}/
Patch a VLAN group object.
ipam_vlan_groups_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-groups/{id}/
Delete a VLAN group object.
ipam_vlan_groups_destroy 1 param → 204
GET
/api/ipam/vlan-groups/{id}/available-vlans/
Get a VLAN object.
ipam_vlan_groups_available_vlans_list 4 params → 200
POST
/api/ipam/vlan-groups/{id}/available-vlans/
Post a VLAN object.
ipam_vlan_groups_available_vlans_create 1 param body → 201
GET
/api/ipam/vlan-translation-policies/
Get a list of VLAN translation policy objects.
ipam_vlan_translation_policies_list 70 params → 200
POST
/api/ipam/vlan-translation-policies/
Post a list of VLAN translation policy objects.
ipam_vlan_translation_policies_create body → 201
PUT
/api/ipam/vlan-translation-policies/
Put a list of VLAN translation policy objects.
ipam_vlan_translation_policies_bulk_update body → 200
PATCH
/api/ipam/vlan-translation-policies/
Patch a list of VLAN translation policy objects.
ipam_vlan_translation_policies_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-translation-policies/
Delete a list of VLAN translation policy objects.
ipam_vlan_translation_policies_bulk_destroy body → 204
GET
/api/ipam/vlan-translation-policies/{id}/
Get a VLAN translation policy object.
ipam_vlan_translation_policies_retrieve 4 params → 200
PUT
/api/ipam/vlan-translation-policies/{id}/
Put a VLAN translation policy object.
ipam_vlan_translation_policies_update 1 param body → 200
PATCH
/api/ipam/vlan-translation-policies/{id}/
Patch a VLAN translation policy object.
ipam_vlan_translation_policies_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-translation-policies/{id}/
Delete a VLAN translation policy object.
ipam_vlan_translation_policies_destroy 1 param → 204
GET
/api/ipam/vlan-translation-rules/
Get a list of VLAN translation rule objects.
ipam_vlan_translation_rules_list 67 params → 200
POST
/api/ipam/vlan-translation-rules/
Post a list of VLAN translation rule objects.
ipam_vlan_translation_rules_create body → 201
PUT
/api/ipam/vlan-translation-rules/
Put a list of VLAN translation rule objects.
ipam_vlan_translation_rules_bulk_update body → 200
PATCH
/api/ipam/vlan-translation-rules/
Patch a list of VLAN translation rule objects.
ipam_vlan_translation_rules_bulk_partial_update body → 200
DELETE
/api/ipam/vlan-translation-rules/
Delete a list of VLAN translation rule objects.
ipam_vlan_translation_rules_bulk_destroy body → 204
GET
/api/ipam/vlan-translation-rules/{id}/
Get a VLAN translation rule object.
ipam_vlan_translation_rules_retrieve 4 params → 200
PUT
/api/ipam/vlan-translation-rules/{id}/
Put a VLAN translation rule object.
ipam_vlan_translation_rules_update 1 param body → 200
PATCH
/api/ipam/vlan-translation-rules/{id}/
Patch a VLAN translation rule object.
ipam_vlan_translation_rules_partial_update 1 param body → 200
DELETE
/api/ipam/vlan-translation-rules/{id}/
Delete a VLAN translation rule object.
ipam_vlan_translation_rules_destroy 1 param → 204
GET
/api/ipam/vlans/
Get a list of VLAN objects.
ipam_vlans_list 149 params → 200
POST
/api/ipam/vlans/
Post a list of VLAN objects.
ipam_vlans_create body → 201
PUT
/api/ipam/vlans/
Put a list of VLAN objects.
ipam_vlans_bulk_update body → 200
PATCH
/api/ipam/vlans/
Patch a list of VLAN objects.
ipam_vlans_bulk_partial_update body → 200
DELETE
/api/ipam/vlans/
Delete a list of VLAN objects.
ipam_vlans_bulk_destroy body → 204
GET
/api/ipam/vlans/{id}/
Get a VLAN object.
ipam_vlans_retrieve 4 params → 200
PUT
/api/ipam/vlans/{id}/
Put a VLAN object.
ipam_vlans_update 1 param body → 200
PATCH
/api/ipam/vlans/{id}/
Patch a VLAN object.
ipam_vlans_partial_update 1 param body → 200
DELETE
/api/ipam/vlans/{id}/
Delete a VLAN object.
ipam_vlans_destroy 1 param → 204
GET
/api/ipam/vrfs/
Get a list of VRF objects.
ipam_vrfs_list 100 params → 200
POST
/api/ipam/vrfs/
Post a list of VRF objects.
ipam_vrfs_create body → 201
PUT
/api/ipam/vrfs/
Put a list of VRF objects.
ipam_vrfs_bulk_update body → 200
PATCH
/api/ipam/vrfs/
Patch a list of VRF objects.
ipam_vrfs_bulk_partial_update body → 200
DELETE
/api/ipam/vrfs/
Delete a list of VRF objects.
ipam_vrfs_bulk_destroy body → 204
GET
/api/ipam/vrfs/{id}/
Get a VRF object.
ipam_vrfs_retrieve 4 params → 200
PUT
/api/ipam/vrfs/{id}/
Put a VRF object.
ipam_vrfs_update 1 param body → 200
PATCH
/api/ipam/vrfs/{id}/
Patch a VRF object.
ipam_vrfs_partial_update 1 param body → 200
DELETE
/api/ipam/vrfs/{id}/
Delete a VRF object.
ipam_vrfs_destroy 1 param → 204

Schemas 152

The contract defines 152 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.

BriefRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
AvailableIP
object
Representation of an IP address which does not exist in the database.
4 properties 3 required
IntegerRange
array
AvailablePrefix
object
Representation of a prefix which does not exist in the database.
3 properties 3 required
BulkAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 3 required
BriefVLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PrefixLengthRequest
object
1 property 1 required
BulkVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 3 required
PatchedRouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties
PaginatedPrefixList
object
4 properties 2 required
PaginatedVLANList
object
4 properties 2 required
ASN
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 9 required
PaginatedASNList
object
4 properties 2 required
PatchedWritableIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
IPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
PatchedBulkRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 1 required
WritableServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 3 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
PatchedVLANTranslationRuleRequest
object
Adds support for custom fields and tags.
4 properties
IPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 required
PaginatedIPRangeList
object
4 properties 2 required
PaginatedIPAddressList
object
4 properties 2 required
BriefSiteRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
WritablePrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
PatchedRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
FHRPGroup
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 9 required
BulkServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 3 required
PatchedBulkFHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
5 properties 1 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
BriefVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 1 required
PatchedBulkVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 1 required
WritableIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
BriefVLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
BulkRoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 3 required
PatchedVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties
VLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties 2 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 6 required
BulkASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 2 required
BulkVLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
12 properties 3 required
PaginatedFHRPGroupList
object
4 properties 2 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
PaginatedRIRList
object
4 properties 2 required
WritableVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 2 required
PaginatedVRFList
object
4 properties 2 required
VLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 2 required
VLANGroup
object
Base serializer class for models inheriting from OrganizationalModel.
21 properties 12 required
PaginatedServiceTemplateList
object
4 properties 2 required
AggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
PatchedBulkPrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 1 required
ServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
IPRange
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 10 required
PaginatedAggregateList
object
4 properties 2 required
BriefFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
PatchedWritableIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
FHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
4 properties 4 required
PaginatedASNRangeList
object
4 properties 2 required
Aggregate
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 9 required
PatchedASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties
CreateAvailableVLANRequest
object
Adds support for custom fields and tags.
8 properties 1 required
ASNRange
object
Base serializer class for models inheriting from OrganizationalModel.
18 properties 12 required
PatchedBulkFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
PatchedBulkRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 1 required
PaginatedRouteTargetList
object
4 properties 2 required
IPAddress
object
Base serializer class for models inheriting from PrimaryModel.
23 properties 10 required
PatchedVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
PatchedBulkASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
BulkASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
12 properties 6 required
BulkFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
ASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
ASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
11 properties 5 required
IntegerRangeRequest
array
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
WritableIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 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
PatchedBulkASNRangeRequest
object
Base serializer class for models inheriting from OrganizationalModel.
12 properties 1 required
RouteTarget
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
PatchedBulkVLANGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
12 properties 1 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
AvailableIPRequestRequest
object
Request payload for creating IP addresses from the available-ips endpoint.
1 property
BulkIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 2 required
PatchedWritableVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties
AvailableASN
object
Representation of an ASN which does not exist in the database.
2 properties 1 required
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
RouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
7 properties 1 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PaginatedFHRPGroupAssignmentList
object
4 properties 2 required
BulkFHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
5 properties 5 required
VLANTranslationRule
object
Adds support for custom fields and tags.
7 properties 6 required
PatchedBulkIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 required
PatchedFHRPGroupAssignmentRequest
object
Adds support for custom fields and tags.
4 properties
PatchedBulkVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
VRF
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 9 required
VRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 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
BulkVLANTranslationRuleRequest
object
Adds support for custom fields and tags.
5 properties 4 required
PatchedASNRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
PatchedBulkAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 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
BulkPrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 2 required
Role
object
Base serializer class for models inheriting from OrganizationalModel.
17 properties 11 required
BulkVLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 2 required
VLANTranslationPolicy
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
PaginatedRoleList
object
4 properties 2 required
BriefFHRPGroup
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefVRF
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 4 required
RIR
object
Base serializer class for models inheriting from OrganizationalModel.
15 properties 9 required
BriefRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
FHRPGroupAssignment
object
Adds support for custom fields and tags.
10 properties 10 required
BriefRIR
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
PatchedFHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
VLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 10 required
BulkIPRangeRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 3 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedBulkServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
PatchedBulkServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
BulkServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 5 required
WritableServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 5 required
PaginatedServiceList
object
4 properties 2 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
PatchedRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties
BulkRIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
9 properties 3 required
VLANTranslationRuleRequest
object
Adds support for custom fields and tags.
4 properties 3 required
Prefix
object
Base serializer class for models inheriting from PrimaryModel.
25 properties 11 required
PaginatedVLANTranslationPolicyList
object
4 properties 2 required
PatchedWritableServiceTemplateRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
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
PatchedWritablePrefixRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PatchedBulkRouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 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
RIRRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
BulkRouteTargetRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 2 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
PatchedWritableAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
AvailableVLAN
object
Representation of a VLAN which does not exist in the database.
2 properties 2 required
BriefRole
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
VLANTranslationPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 1 required
PatchedWritableServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
Service
object
Base serializer class for models inheriting from PrimaryModel.
18 properties 11 required
PatchedBulkVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
PaginatedVLANGroupList
object
4 properties 2 required
FHRPGroupRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
WritableAggregateRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
BulkVRFRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
RoleRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 2 required
PatchedBulkVLANTranslationRuleRequest
object
Adds support for custom fields and tags.
5 properties 1 required
ServiceRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
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
PatchedBulkIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
PaginatedVLANTranslationRuleList
object
4 properties 2 required
BriefSite
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-ipam-api-openapi.yml Raw ↑

Other APIs NetBox Labs publishes across the network.

NetBox Labs authentication-check API
AE Profile APIs.io
NetBox Labs circuits API
AE Profile APIs.io
NetBox Labs core API
AE Profile APIs.io
NetBox Labs dcim API
AE Profile APIs.io
NetBox Labs extras API
AE Profile APIs.io
NetBox Labs schema API
AE Profile APIs.io
NetBox Labs status API
AE Profile APIs.io
NetBox Labs tenancy API
AE Profile APIs.io
NetBox Labs users API
AE Profile APIs.io
NetBox Labs virtualization API
AE Profile APIs.io
NetBox Labs vpn API
AE Profile APIs.io
NetBox Labs wireless API
AE Profile APIs.io
#ipam
← Back to N APIs
API Details
ID
netbox-labs:netbox-labs-ipam-api
Base URL
https://demo.netbox.dev/api/
Docs
https://netboxlabs.com/docs/netbox/integrations/rest-api/
Provider
NetBox Labs
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network