NetBox · Capability

NetBox REST API — ipam

NetBox REST API — ipam. 172 operations. Lead operation: ipam. Self-contained Naftiko capability covering one Netbox business surface.

Run with Naftiko Netboxipam

What You Can Do

GET
Ipamaggregateslist — Get a list of aggregate objects.
/v1/api/ipam/aggregates
POST
Ipamaggregatescreate — Post a list of aggregate objects.
/v1/api/ipam/aggregates
PUT
Ipamaggregatesbulkupdate — Put a list of aggregate objects.
/v1/api/ipam/aggregates
PATCH
Ipamaggregatesbulkpartialupdate — Patch a list of aggregate objects.
/v1/api/ipam/aggregates
DELETE
Ipamaggregatesbulkdestroy — Delete a list of aggregate objects.
/v1/api/ipam/aggregates
GET
Ipamaggregatesretrieve — Get a aggregate object.
/v1/api/ipam/aggregates/{id}
PUT
Ipamaggregatesupdate — Put a aggregate object.
/v1/api/ipam/aggregates/{id}
PATCH
Ipamaggregatespartialupdate — Patch a aggregate object.
/v1/api/ipam/aggregates/{id}
DELETE
Ipamaggregatesdestroy — Delete a aggregate object.
/v1/api/ipam/aggregates/{id}
GET
Ipamasnrangeslist — Get a list of ASN range objects.
/v1/api/ipam/asn-ranges
POST
Ipamasnrangescreate — Post a list of ASN range objects.
/v1/api/ipam/asn-ranges
PUT
Ipamasnrangesbulkupdate — Put a list of ASN range objects.
/v1/api/ipam/asn-ranges
PATCH
Ipamasnrangesbulkpartialupdate — Patch a list of ASN range objects.
/v1/api/ipam/asn-ranges
DELETE
Ipamasnrangesbulkdestroy — Delete a list of ASN range objects.
/v1/api/ipam/asn-ranges
GET
Ipamasnrangesretrieve — Get a ASN range object.
/v1/api/ipam/asn-ranges/{id}
PUT
Ipamasnrangesupdate — Put a ASN range object.
/v1/api/ipam/asn-ranges/{id}
PATCH
Ipamasnrangespartialupdate — Patch a ASN range object.
/v1/api/ipam/asn-ranges/{id}
DELETE
Ipamasnrangesdestroy — Delete a ASN range object.
/v1/api/ipam/asn-ranges/{id}
GET
Ipamasnrangesavailableasnslist — Get a ASN object.
/v1/api/ipam/asn-ranges/{id}/available-asns
POST
Ipamasnrangesavailableasnscreate — Post a ASN object.
/v1/api/ipam/asn-ranges/{id}/available-asns
GET
Ipamasnslist — Get a list of ASN objects.
/v1/api/ipam/asns
POST
Ipamasnscreate — Post a list of ASN objects.
/v1/api/ipam/asns
PUT
Ipamasnsbulkupdate — Put a list of ASN objects.
/v1/api/ipam/asns
PATCH
Ipamasnsbulkpartialupdate — Patch a list of ASN objects.
/v1/api/ipam/asns
DELETE
Ipamasnsbulkdestroy — Delete a list of ASN objects.
/v1/api/ipam/asns
GET
Ipamasnsretrieve — Get a ASN object.
/v1/api/ipam/asns/{id}
PUT
Ipamasnsupdate — Put a ASN object.
/v1/api/ipam/asns/{id}
PATCH
Ipamasnspartialupdate — Patch a ASN object.
/v1/api/ipam/asns/{id}
DELETE
Ipamasnsdestroy — Delete a ASN object.
/v1/api/ipam/asns/{id}
GET
Ipamfhrpgroupassignmentslist — Get a list of FHRP group assignment objects.
/v1/api/ipam/fhrp-group-assignments
POST
Ipamfhrpgroupassignmentscreate — Post a list of FHRP group assignment objects.
/v1/api/ipam/fhrp-group-assignments
PUT
Ipamfhrpgroupassignmentsbulkupdate — Put a list of FHRP group assignment objects.
/v1/api/ipam/fhrp-group-assignments
PATCH
Ipamfhrpgroupassignmentsbulkpartialupdate — Patch a list of FHRP group assignment objects.
/v1/api/ipam/fhrp-group-assignments
DELETE
Ipamfhrpgroupassignmentsbulkdestroy — Delete a list of FHRP group assignment objects.
/v1/api/ipam/fhrp-group-assignments
GET
Ipamfhrpgroupassignmentsretrieve — Get a FHRP group assignment object.
/v1/api/ipam/fhrp-group-assignments/{id}
PUT
Ipamfhrpgroupassignmentsupdate — Put a FHRP group assignment object.
/v1/api/ipam/fhrp-group-assignments/{id}
PATCH
Ipamfhrpgroupassignmentspartialupdate — Patch a FHRP group assignment object.
/v1/api/ipam/fhrp-group-assignments/{id}
DELETE
Ipamfhrpgroupassignmentsdestroy — Delete a FHRP group assignment object.
/v1/api/ipam/fhrp-group-assignments/{id}
GET
Ipamfhrpgroupslist — Get a list of FHRP group objects.
/v1/api/ipam/fhrp-groups
POST
Ipamfhrpgroupscreate — Post a list of FHRP group objects.
/v1/api/ipam/fhrp-groups
PUT
Ipamfhrpgroupsbulkupdate — Put a list of FHRP group objects.
/v1/api/ipam/fhrp-groups
PATCH
Ipamfhrpgroupsbulkpartialupdate — Patch a list of FHRP group objects.
/v1/api/ipam/fhrp-groups
DELETE
Ipamfhrpgroupsbulkdestroy — Delete a list of FHRP group objects.
/v1/api/ipam/fhrp-groups
GET
Ipamfhrpgroupsretrieve — Get a FHRP group object.
/v1/api/ipam/fhrp-groups/{id}
PUT
Ipamfhrpgroupsupdate — Put a FHRP group object.
/v1/api/ipam/fhrp-groups/{id}
PATCH
Ipamfhrpgroupspartialupdate — Patch a FHRP group object.
/v1/api/ipam/fhrp-groups/{id}
DELETE
Ipamfhrpgroupsdestroy — Delete a FHRP group object.
/v1/api/ipam/fhrp-groups/{id}
GET
Ipamipaddresseslist — Get a list of IP address objects.
/v1/api/ipam/ip-addresses
POST
Ipamipaddressescreate — Post a list of IP address objects.
/v1/api/ipam/ip-addresses
PUT
Ipamipaddressesbulkupdate — Put a list of IP address objects.
/v1/api/ipam/ip-addresses
PATCH
Ipamipaddressesbulkpartialupdate — Patch a list of IP address objects.
/v1/api/ipam/ip-addresses
DELETE
Ipamipaddressesbulkdestroy — Delete a list of IP address objects.
/v1/api/ipam/ip-addresses
GET
Ipamipaddressesretrieve — Get a IP address object.
/v1/api/ipam/ip-addresses/{id}
PUT
Ipamipaddressesupdate — Put a IP address object.
/v1/api/ipam/ip-addresses/{id}
PATCH
Ipamipaddressespartialupdate — Patch a IP address object.
/v1/api/ipam/ip-addresses/{id}
DELETE
Ipamipaddressesdestroy — Delete a IP address object.
/v1/api/ipam/ip-addresses/{id}
GET
Ipamiprangeslist — Get a list of IP range objects.
/v1/api/ipam/ip-ranges
POST
Ipamiprangescreate — Post a list of IP range objects.
/v1/api/ipam/ip-ranges
PUT
Ipamiprangesbulkupdate — Put a list of IP range objects.
/v1/api/ipam/ip-ranges
PATCH
Ipamiprangesbulkpartialupdate — Patch a list of IP range objects.
/v1/api/ipam/ip-ranges
DELETE
Ipamiprangesbulkdestroy — Delete a list of IP range objects.
/v1/api/ipam/ip-ranges
GET
Ipamiprangesretrieve — Get a IP range object.
/v1/api/ipam/ip-ranges/{id}
PUT
Ipamiprangesupdate — Put a IP range object.
/v1/api/ipam/ip-ranges/{id}
PATCH
Ipamiprangespartialupdate — Patch a IP range object.
/v1/api/ipam/ip-ranges/{id}
DELETE
Ipamiprangesdestroy — Delete a IP range object.
/v1/api/ipam/ip-ranges/{id}
GET
Ipamiprangesavailableipslist — Get a IP address object.
/v1/api/ipam/ip-ranges/{id}/available-ips
POST
Ipamiprangesavailableipscreate — Post a IP address object.
/v1/api/ipam/ip-ranges/{id}/available-ips
GET
Ipamprefixeslist — Get a list of prefix objects.
/v1/api/ipam/prefixes
POST
Ipamprefixescreate — Post a list of prefix objects.
/v1/api/ipam/prefixes
PUT
Ipamprefixesbulkupdate — Put a list of prefix objects.
/v1/api/ipam/prefixes
PATCH
Ipamprefixesbulkpartialupdate — Patch a list of prefix objects.
/v1/api/ipam/prefixes
DELETE
Ipamprefixesbulkdestroy — Delete a list of prefix objects.
/v1/api/ipam/prefixes
GET
Ipamprefixesretrieve — Get a prefix object.
/v1/api/ipam/prefixes/{id}
PUT
Ipamprefixesupdate — Put a prefix object.
/v1/api/ipam/prefixes/{id}
PATCH
Ipamprefixespartialupdate — Patch a prefix object.
/v1/api/ipam/prefixes/{id}
DELETE
Ipamprefixesdestroy — Delete a prefix object.
/v1/api/ipam/prefixes/{id}
GET
Ipamprefixesavailableipslist — Get a IP address object.
/v1/api/ipam/prefixes/{id}/available-ips
POST
Ipamprefixesavailableipscreate — Post a IP address object.
/v1/api/ipam/prefixes/{id}/available-ips
GET
Ipamprefixesavailableprefixeslist — Get a prefix object.
/v1/api/ipam/prefixes/{id}/available-prefixes
POST
Ipamprefixesavailableprefixescreate — Post a prefix object.
/v1/api/ipam/prefixes/{id}/available-prefixes
GET
Ipamrirslist — Get a list of RIR objects.
/v1/api/ipam/rirs
POST
Ipamrirscreate — Post a list of RIR objects.
/v1/api/ipam/rirs
PUT
Ipamrirsbulkupdate — Put a list of RIR objects.
/v1/api/ipam/rirs
PATCH
Ipamrirsbulkpartialupdate — Patch a list of RIR objects.
/v1/api/ipam/rirs
DELETE
Ipamrirsbulkdestroy — Delete a list of RIR objects.
/v1/api/ipam/rirs
GET
Ipamrirsretrieve — Get a RIR object.
/v1/api/ipam/rirs/{id}
PUT
Ipamrirsupdate — Put a RIR object.
/v1/api/ipam/rirs/{id}
PATCH
Ipamrirspartialupdate — Patch a RIR object.
/v1/api/ipam/rirs/{id}
DELETE
Ipamrirsdestroy — Delete a RIR object.
/v1/api/ipam/rirs/{id}
GET
Ipamroleslist — Get a list of role objects.
/v1/api/ipam/roles
POST
Ipamrolescreate — Post a list of role objects.
/v1/api/ipam/roles
PUT
Ipamrolesbulkupdate — Put a list of role objects.
/v1/api/ipam/roles
PATCH
Ipamrolesbulkpartialupdate — Patch a list of role objects.
/v1/api/ipam/roles
DELETE
Ipamrolesbulkdestroy — Delete a list of role objects.
/v1/api/ipam/roles
GET
Ipamrolesretrieve — Get a role object.
/v1/api/ipam/roles/{id}
PUT
Ipamrolesupdate — Put a role object.
/v1/api/ipam/roles/{id}
PATCH
Ipamrolespartialupdate — Patch a role object.
/v1/api/ipam/roles/{id}
DELETE
Ipamrolesdestroy — Delete a role object.
/v1/api/ipam/roles/{id}
GET
Ipamroutetargetslist — Get a list of route target objects.
/v1/api/ipam/route-targets
POST
Ipamroutetargetscreate — Post a list of route target objects.
/v1/api/ipam/route-targets
PUT
Ipamroutetargetsbulkupdate — Put a list of route target objects.
/v1/api/ipam/route-targets
PATCH
Ipamroutetargetsbulkpartialupdate — Patch a list of route target objects.
/v1/api/ipam/route-targets
DELETE
Ipamroutetargetsbulkdestroy — Delete a list of route target objects.
/v1/api/ipam/route-targets
GET
Ipamroutetargetsretrieve — Get a route target object.
/v1/api/ipam/route-targets/{id}
PUT
Ipamroutetargetsupdate — Put a route target object.
/v1/api/ipam/route-targets/{id}
PATCH
Ipamroutetargetspartialupdate — Patch a route target object.
/v1/api/ipam/route-targets/{id}
DELETE
Ipamroutetargetsdestroy — Delete a route target object.
/v1/api/ipam/route-targets/{id}
GET
Ipamservicetemplateslist — Get a list of application service template objects.
/v1/api/ipam/service-templates
POST
Ipamservicetemplatescreate — Post a list of application service template objects.
/v1/api/ipam/service-templates
PUT
Ipamservicetemplatesbulkupdate — Put a list of application service template objects.
/v1/api/ipam/service-templates
PATCH
Ipamservicetemplatesbulkpartialupdate — Patch a list of application service template objects.
/v1/api/ipam/service-templates
DELETE
Ipamservicetemplatesbulkdestroy — Delete a list of application service template objects.
/v1/api/ipam/service-templates
GET
Ipamservicetemplatesretrieve — Get a application service template object.
/v1/api/ipam/service-templates/{id}
PUT
Ipamservicetemplatesupdate — Put a application service template object.
/v1/api/ipam/service-templates/{id}
PATCH
Ipamservicetemplatespartialupdate — Patch a application service template object.
/v1/api/ipam/service-templates/{id}
DELETE
Ipamservicetemplatesdestroy — Delete a application service template object.
/v1/api/ipam/service-templates/{id}
GET
Ipamserviceslist — Get a list of application service objects.
/v1/api/ipam/services
POST
Ipamservicescreate — Post a list of application service objects.
/v1/api/ipam/services
PUT
Ipamservicesbulkupdate — Put a list of application service objects.
/v1/api/ipam/services
PATCH
Ipamservicesbulkpartialupdate — Patch a list of application service objects.
/v1/api/ipam/services
DELETE
Ipamservicesbulkdestroy — Delete a list of application service objects.
/v1/api/ipam/services
GET
Ipamservicesretrieve — Get a application service object.
/v1/api/ipam/services/{id}
PUT
Ipamservicesupdate — Put a application service object.
/v1/api/ipam/services/{id}
PATCH
Ipamservicespartialupdate — Patch a application service object.
/v1/api/ipam/services/{id}
DELETE
Ipamservicesdestroy — Delete a application service object.
/v1/api/ipam/services/{id}
GET
Ipamvlangroupslist — Get a list of VLAN group objects.
/v1/api/ipam/vlan-groups
POST
Ipamvlangroupscreate — Post a list of VLAN group objects.
/v1/api/ipam/vlan-groups
PUT
Ipamvlangroupsbulkupdate — Put a list of VLAN group objects.
/v1/api/ipam/vlan-groups
PATCH
Ipamvlangroupsbulkpartialupdate — Patch a list of VLAN group objects.
/v1/api/ipam/vlan-groups
DELETE
Ipamvlangroupsbulkdestroy — Delete a list of VLAN group objects.
/v1/api/ipam/vlan-groups
GET
Ipamvlangroupsretrieve — Get a VLAN group object.
/v1/api/ipam/vlan-groups/{id}
PUT
Ipamvlangroupsupdate — Put a VLAN group object.
/v1/api/ipam/vlan-groups/{id}
PATCH
Ipamvlangroupspartialupdate — Patch a VLAN group object.
/v1/api/ipam/vlan-groups/{id}
DELETE
Ipamvlangroupsdestroy — Delete a VLAN group object.
/v1/api/ipam/vlan-groups/{id}
GET
Ipamvlangroupsavailablevlanslist — Get a VLAN object.
/v1/api/ipam/vlan-groups/{id}/available-vlans
POST
Ipamvlangroupsavailablevlanscreate — Post a VLAN object.
/v1/api/ipam/vlan-groups/{id}/available-vlans
GET
Ipamvlantranslationpolicieslist — Get a list of VLAN translation policy objects.
/v1/api/ipam/vlan-translation-policies
POST
Ipamvlantranslationpoliciescreate — Post a list of VLAN translation policy objects.
/v1/api/ipam/vlan-translation-policies
PUT
Ipamvlantranslationpoliciesbulkupdate — Put a list of VLAN translation policy objects.
/v1/api/ipam/vlan-translation-policies
PATCH
Ipamvlantranslationpoliciesbulkpartialupdate — Patch a list of VLAN translation policy objects.
/v1/api/ipam/vlan-translation-policies
DELETE
Ipamvlantranslationpoliciesbulkdestroy — Delete a list of VLAN translation policy objects.
/v1/api/ipam/vlan-translation-policies
GET
Ipamvlantranslationpoliciesretrieve — Get a VLAN translation policy object.
/v1/api/ipam/vlan-translation-policies/{id}
PUT
Ipamvlantranslationpoliciesupdate — Put a VLAN translation policy object.
/v1/api/ipam/vlan-translation-policies/{id}
PATCH
Ipamvlantranslationpoliciespartialupdate — Patch a VLAN translation policy object.
/v1/api/ipam/vlan-translation-policies/{id}
DELETE
Ipamvlantranslationpoliciesdestroy — Delete a VLAN translation policy object.
/v1/api/ipam/vlan-translation-policies/{id}
GET
Ipamvlantranslationruleslist — Get a list of VLAN translation rule objects.
/v1/api/ipam/vlan-translation-rules
POST
Ipamvlantranslationrulescreate — Post a list of VLAN translation rule objects.
/v1/api/ipam/vlan-translation-rules
PUT
Ipamvlantranslationrulesbulkupdate — Put a list of VLAN translation rule objects.
/v1/api/ipam/vlan-translation-rules
PATCH
Ipamvlantranslationrulesbulkpartialupdate — Patch a list of VLAN translation rule objects.
/v1/api/ipam/vlan-translation-rules
DELETE
Ipamvlantranslationrulesbulkdestroy — Delete a list of VLAN translation rule objects.
/v1/api/ipam/vlan-translation-rules
GET
Ipamvlantranslationrulesretrieve — Get a VLAN translation rule object.
/v1/api/ipam/vlan-translation-rules/{id}
PUT
Ipamvlantranslationrulesupdate — Put a VLAN translation rule object.
/v1/api/ipam/vlan-translation-rules/{id}
PATCH
Ipamvlantranslationrulespartialupdate — Patch a VLAN translation rule object.
/v1/api/ipam/vlan-translation-rules/{id}
DELETE
Ipamvlantranslationrulesdestroy — Delete a VLAN translation rule object.
/v1/api/ipam/vlan-translation-rules/{id}
GET
Ipamvlanslist — Get a list of VLAN objects.
/v1/api/ipam/vlans
POST
Ipamvlanscreate — Post a list of VLAN objects.
/v1/api/ipam/vlans
PUT
Ipamvlansbulkupdate — Put a list of VLAN objects.
/v1/api/ipam/vlans
PATCH
Ipamvlansbulkpartialupdate — Patch a list of VLAN objects.
/v1/api/ipam/vlans
DELETE
Ipamvlansbulkdestroy — Delete a list of VLAN objects.
/v1/api/ipam/vlans
GET
Ipamvlansretrieve — Get a VLAN object.
/v1/api/ipam/vlans/{id}
PUT
Ipamvlansupdate — Put a VLAN object.
/v1/api/ipam/vlans/{id}
PATCH
Ipamvlanspartialupdate — Patch a VLAN object.
/v1/api/ipam/vlans/{id}
DELETE
Ipamvlansdestroy — Delete a VLAN object.
/v1/api/ipam/vlans/{id}
GET
Ipamvrfslist — Get a list of VRF objects.
/v1/api/ipam/vrfs
POST
Ipamvrfscreate — Post a list of VRF objects.
/v1/api/ipam/vrfs
PUT
Ipamvrfsbulkupdate — Put a list of VRF objects.
/v1/api/ipam/vrfs
PATCH
Ipamvrfsbulkpartialupdate — Patch a list of VRF objects.
/v1/api/ipam/vrfs
DELETE
Ipamvrfsbulkdestroy — Delete a list of VRF objects.
/v1/api/ipam/vrfs
GET
Ipamvrfsretrieve — Get a VRF object.
/v1/api/ipam/vrfs/{id}
PUT
Ipamvrfsupdate — Put a VRF object.
/v1/api/ipam/vrfs/{id}
PATCH
Ipamvrfspartialupdate — Patch a VRF object.
/v1/api/ipam/vrfs/{id}
DELETE
Ipamvrfsdestroy — Delete a VRF object.
/v1/api/ipam/vrfs/{id}

MCP Tools

get-list-aggregate-objects

Get a list of aggregate objects.

read-only idempotent
post-list-aggregate-objects

Post a list of aggregate objects.

read-only
put-list-aggregate-objects

Put a list of aggregate objects.

idempotent
patch-list-aggregate-objects

Patch a list of aggregate objects.

idempotent
delete-list-aggregate-objects

Delete a list of aggregate objects.

idempotent
get-aggregate-object

Get a aggregate object.

read-only idempotent
put-aggregate-object

Put a aggregate object.

idempotent
patch-aggregate-object

Patch a aggregate object.

idempotent
delete-aggregate-object

Delete a aggregate object.

idempotent
get-list-asn-range-objects

Get a list of ASN range objects.

read-only idempotent
post-list-asn-range-objects

Post a list of ASN range objects.

read-only
put-list-asn-range-objects

Put a list of ASN range objects.

idempotent
patch-list-asn-range-objects

Patch a list of ASN range objects.

idempotent
delete-list-asn-range-objects

Delete a list of ASN range objects.

idempotent
get-asn-range-object

Get a ASN range object.

read-only idempotent
put-asn-range-object

Put a ASN range object.

idempotent
patch-asn-range-object

Patch a ASN range object.

idempotent
delete-asn-range-object

Delete a ASN range object.

idempotent
get-asn-object

Get a ASN object.

read-only idempotent
post-asn-object

Post a ASN object.

get-list-asn-objects

Get a list of ASN objects.

read-only idempotent
post-list-asn-objects

Post a list of ASN objects.

read-only
put-list-asn-objects

Put a list of ASN objects.

idempotent
patch-list-asn-objects

Patch a list of ASN objects.

idempotent
delete-list-asn-objects

Delete a list of ASN objects.

idempotent
get-asn-object-2

Get a ASN object.

read-only idempotent
put-asn-object

Put a ASN object.

idempotent
patch-asn-object

Patch a ASN object.

idempotent
delete-asn-object

Delete a ASN object.

idempotent
get-list-fhrp-group-assignment

Get a list of FHRP group assignment objects.

read-only idempotent
post-list-fhrp-group-assignment

Post a list of FHRP group assignment objects.

read-only
put-list-fhrp-group-assignment

Put a list of FHRP group assignment objects.

idempotent
patch-list-fhrp-group-assignment

Patch a list of FHRP group assignment objects.

idempotent
delete-list-fhrp-group-assignment

Delete a list of FHRP group assignment objects.

idempotent
get-fhrp-group-assignment-object

Get a FHRP group assignment object.

read-only idempotent
put-fhrp-group-assignment-object

Put a FHRP group assignment object.

idempotent
patch-fhrp-group-assignment-object

Patch a FHRP group assignment object.

idempotent
delete-fhrp-group-assignment-object

Delete a FHRP group assignment object.

idempotent
get-list-fhrp-group-objects

Get a list of FHRP group objects.

read-only idempotent
post-list-fhrp-group-objects

Post a list of FHRP group objects.

read-only
put-list-fhrp-group-objects

Put a list of FHRP group objects.

idempotent
patch-list-fhrp-group-objects

Patch a list of FHRP group objects.

idempotent
delete-list-fhrp-group-objects

Delete a list of FHRP group objects.

idempotent
get-fhrp-group-object

Get a FHRP group object.

read-only idempotent
put-fhrp-group-object

Put a FHRP group object.

idempotent
patch-fhrp-group-object

Patch a FHRP group object.

idempotent
delete-fhrp-group-object

Delete a FHRP group object.

idempotent
get-list-ip-address-objects

Get a list of IP address objects.

read-only idempotent
post-list-ip-address-objects

Post a list of IP address objects.

read-only
put-list-ip-address-objects

Put a list of IP address objects.

idempotent
patch-list-ip-address-objects

Patch a list of IP address objects.

idempotent
delete-list-ip-address-objects

Delete a list of IP address objects.

idempotent
get-ip-address-object

Get a IP address object.

read-only idempotent
put-ip-address-object

Put a IP address object.

idempotent
patch-ip-address-object

Patch a IP address object.

idempotent
delete-ip-address-object

Delete a IP address object.

idempotent
get-list-ip-range-objects

Get a list of IP range objects.

read-only idempotent
post-list-ip-range-objects

Post a list of IP range objects.

read-only
put-list-ip-range-objects

Put a list of IP range objects.

idempotent
patch-list-ip-range-objects

Patch a list of IP range objects.

idempotent
delete-list-ip-range-objects

Delete a list of IP range objects.

idempotent
get-ip-range-object

Get a IP range object.

read-only idempotent
put-ip-range-object

Put a IP range object.

idempotent
patch-ip-range-object

Patch a IP range object.

idempotent
delete-ip-range-object

Delete a IP range object.

idempotent
get-ip-address-object-2

Get a IP address object.

read-only idempotent
post-ip-address-object

Post a IP address object.

get-list-prefix-objects

Get a list of prefix objects.

read-only idempotent
post-list-prefix-objects

Post a list of prefix objects.

read-only
put-list-prefix-objects

Put a list of prefix objects.

idempotent
patch-list-prefix-objects

Patch a list of prefix objects.

idempotent
delete-list-prefix-objects

Delete a list of prefix objects.

idempotent
get-prefix-object

Get a prefix object.

read-only idempotent
put-prefix-object

Put a prefix object.

idempotent
patch-prefix-object

Patch a prefix object.

idempotent
delete-prefix-object

Delete a prefix object.

idempotent
get-ip-address-object-3

Get a IP address object.

read-only idempotent
post-ip-address-object-2

Post a IP address object.

get-prefix-object-2

Get a prefix object.

read-only idempotent
post-prefix-object

Post a prefix object.

get-list-rir-objects

Get a list of RIR objects.

read-only idempotent
post-list-rir-objects

Post a list of RIR objects.

read-only
put-list-rir-objects

Put a list of RIR objects.

idempotent
patch-list-rir-objects

Patch a list of RIR objects.

idempotent
delete-list-rir-objects

Delete a list of RIR objects.

idempotent
get-rir-object

Get a RIR object.

read-only idempotent
put-rir-object

Put a RIR object.

idempotent
patch-rir-object

Patch a RIR object.

idempotent
delete-rir-object

Delete a RIR object.

idempotent
get-list-role-objects

Get a list of role objects.

read-only idempotent
post-list-role-objects

Post a list of role objects.

read-only
put-list-role-objects

Put a list of role objects.

idempotent
patch-list-role-objects

Patch a list of role objects.

idempotent
delete-list-role-objects

Delete a list of role objects.

idempotent
get-role-object

Get a role object.

read-only idempotent
put-role-object

Put a role object.

idempotent
patch-role-object

Patch a role object.

idempotent
delete-role-object

Delete a role object.

idempotent
get-list-route-target-objects

Get a list of route target objects.

read-only idempotent
post-list-route-target-objects

Post a list of route target objects.

read-only
put-list-route-target-objects

Put a list of route target objects.

idempotent
patch-list-route-target-objects

Patch a list of route target objects.

idempotent
delete-list-route-target-objects

Delete a list of route target objects.

idempotent
get-route-target-object

Get a route target object.

read-only idempotent
put-route-target-object

Put a route target object.

idempotent
patch-route-target-object

Patch a route target object.

idempotent
delete-route-target-object

Delete a route target object.

idempotent
get-list-application-service-template

Get a list of application service template objects.

read-only idempotent
post-list-application-service-template

Post a list of application service template objects.

read-only
put-list-application-service-template

Put a list of application service template objects.

idempotent
patch-list-application-service-template

Patch a list of application service template objects.

idempotent
delete-list-application-service-template

Delete a list of application service template objects.

idempotent
get-application-service-template-object

Get a application service template object.

read-only idempotent
put-application-service-template-object

Put a application service template object.

idempotent
patch-application-service-template-object

Patch a application service template object.

idempotent
delete-application-service-template-object

Delete a application service template object.

idempotent
get-list-application-service-objects

Get a list of application service objects.

read-only idempotent
post-list-application-service-objects

Post a list of application service objects.

read-only
put-list-application-service-objects

Put a list of application service objects.

idempotent
patch-list-application-service-objects

Patch a list of application service objects.

idempotent
delete-list-application-service-objects

Delete a list of application service objects.

idempotent
get-application-service-object

Get a application service object.

read-only idempotent
put-application-service-object

Put a application service object.

idempotent
patch-application-service-object

Patch a application service object.

idempotent
delete-application-service-object

Delete a application service object.

idempotent
get-list-vlan-group-objects

Get a list of VLAN group objects.

read-only idempotent
post-list-vlan-group-objects

Post a list of VLAN group objects.

read-only
put-list-vlan-group-objects

Put a list of VLAN group objects.

idempotent
patch-list-vlan-group-objects

Patch a list of VLAN group objects.

idempotent
delete-list-vlan-group-objects

Delete a list of VLAN group objects.

idempotent
get-vlan-group-object

Get a VLAN group object.

read-only idempotent
put-vlan-group-object

Put a VLAN group object.

idempotent
patch-vlan-group-object

Patch a VLAN group object.

idempotent
delete-vlan-group-object

Delete a VLAN group object.

idempotent
get-vlan-object

Get a VLAN object.

read-only idempotent
post-vlan-object

Post a VLAN object.

get-list-vlan-translation-policy

Get a list of VLAN translation policy objects.

read-only idempotent
post-list-vlan-translation-policy

Post a list of VLAN translation policy objects.

read-only
put-list-vlan-translation-policy

Put a list of VLAN translation policy objects.

idempotent
patch-list-vlan-translation-policy

Patch a list of VLAN translation policy objects.

idempotent
delete-list-vlan-translation-policy

Delete a list of VLAN translation policy objects.

idempotent
get-vlan-translation-policy-object

Get a VLAN translation policy object.

read-only idempotent
put-vlan-translation-policy-object

Put a VLAN translation policy object.

idempotent
patch-vlan-translation-policy-object

Patch a VLAN translation policy object.

idempotent
delete-vlan-translation-policy-object

Delete a VLAN translation policy object.

idempotent
get-list-vlan-translation-rule

Get a list of VLAN translation rule objects.

read-only idempotent
post-list-vlan-translation-rule

Post a list of VLAN translation rule objects.

read-only
put-list-vlan-translation-rule

Put a list of VLAN translation rule objects.

idempotent
patch-list-vlan-translation-rule

Patch a list of VLAN translation rule objects.

idempotent
delete-list-vlan-translation-rule

Delete a list of VLAN translation rule objects.

idempotent
get-vlan-translation-rule-object

Get a VLAN translation rule object.

read-only idempotent
put-vlan-translation-rule-object

Put a VLAN translation rule object.

idempotent
patch-vlan-translation-rule-object

Patch a VLAN translation rule object.

idempotent
delete-vlan-translation-rule-object

Delete a VLAN translation rule object.

idempotent
get-list-vlan-objects

Get a list of VLAN objects.

read-only idempotent
post-list-vlan-objects

Post a list of VLAN objects.

read-only
put-list-vlan-objects

Put a list of VLAN objects.

idempotent
patch-list-vlan-objects

Patch a list of VLAN objects.

idempotent
delete-list-vlan-objects

Delete a list of VLAN objects.

idempotent
get-vlan-object-2

Get a VLAN object.

read-only idempotent
put-vlan-object

Put a VLAN object.

idempotent
patch-vlan-object

Patch a VLAN object.

idempotent
delete-vlan-object

Delete a VLAN object.

idempotent
get-list-vrf-objects

Get a list of VRF objects.

read-only idempotent
post-list-vrf-objects

Post a list of VRF objects.

read-only
put-list-vrf-objects

Put a list of VRF objects.

idempotent
patch-list-vrf-objects

Patch a list of VRF objects.

idempotent
delete-list-vrf-objects

Delete a list of VRF objects.

idempotent
get-vrf-object

Get a VRF object.

read-only idempotent
put-vrf-object

Put a VRF object.

idempotent
patch-vrf-object

Patch a VRF object.

idempotent
delete-vrf-object

Delete a VRF object.

idempotent

Capability Spec

netbox-ipam.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: NetBox REST API — ipam
  description: 'NetBox REST API — ipam. 172 operations. Lead operation: ipam. Self-contained Naftiko capability covering one
    Netbox business surface.'
  tags:
  - Netbox
  - ipam
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBOX_API_KEY: NETBOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbox-ipam
    baseUri: ''
    description: NetBox REST API — ipam business capability. Self-contained, no shared references.
    resources:
    - name: api-ipam-aggregates
      path: /api/ipam/aggregates/
      operations:
      - name: ipamaggregateslist
        method: GET
        description: Get a list of aggregate objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contact
          in: query
          type: array
          description: Contact
        - name: contact__n
          in: query
          type: array
          description: Contact
        - name: contact_group
          in: query
          type: array
        - name: contact_group__n
          in: query
          type: array
        - name: contact_role
          in: query
          type: array
          description: Contact Role
        - name: contact_role__n
          in: query
          type: array
          description: Contact Role
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: date_added
          in: query
          type: array
        - name: date_added__empty
          in: query
          type: boolean
        - name: date_added__gt
          in: query
          type: array
        - name: date_added__gte
          in: query
          type: array
        - name: date_added__lt
          in: query
          type: array
        - name: date_added__lte
          in: query
          type: array
        - name: date_added__n
          in: query
          type: array
        - name: description
          in: query
          type: array
        - name: description__empty
          in: query
          type: boolean
        - name: description__ic
          in: query
          type: array
        - name: description__ie
          in: query
          type: array
        - name: description__iew
          in: query
          type: array
        - name: description__iregex
          in: query
          type: array
        - name: description__isw
          in: query
          type: array
        - name: description__n
          in: query
          type: array
        - name: description__nic
          in: query
          type: array
        - name: description__nie
          in: query
          type: array
        - name: description__niew
          in: query
          type: array
        - name: description__nisw
          in: query
          type: array
        - name: description__regex
          in: query
          type: array
        - name: family
          in: query
          type: number
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: modified_by_request
          in: query
          type: string
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: owner
          in: query
          type: array
          description: Owner (name)
        - name: owner__n
          in: query
          type: array
          description: Owner (name)
        - name: owner_group
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group__n
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group_id
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_group_id__n
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_id
          in: query
          type: array
          description: Owner (ID)
        - name: owner_id__n
          in: query
          type: array
          description: Owner (ID)
        - name: prefix
          in: query
          type: string
          description: Prefix
        - name: q
          in: query
          type: string
          description: Search
        - name: rir
          in: query
          type: array
          description: RIR (slug)
        - name: rir__n
          in: query
          type: array
          description: RIR (slug)
        - name: rir_id
          in: query
          type: array
          description: RIR (ID)
        - name: rir_id__n
          in: query
          type: array
          description: RIR (ID)
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: tenant
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant__n
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant_group
          in: query
          type: array
        - name: tenant_group__n
          in: query
          type: array
        - name: tenant_group_id
          in: query
          type: array
        - name: tenant_group_id__n
          in: query
          type: array
        - name: tenant_id
          in: query
          type: array
          description: Tenant (ID)
        - name: tenant_id__n
          in: query
          type: array
          description: Tenant (ID)
        - name: updated_by_request
          in: query
          type: string
      - name: ipamaggregatescreate
        method: POST
        description: Post a list of aggregate objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamaggregatesbulkupdate
        method: PUT
        description: Put a list of aggregate objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamaggregatesbulkpartialupdate
        method: PATCH
        description: Patch a list of aggregate objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamaggregatesbulkdestroy
        method: DELETE
        description: Delete a list of aggregate objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-ipam-aggregates-id
      path: /api/ipam/aggregates/{id}/
      operations:
      - name: ipamaggregatesretrieve
        method: GET
        description: Get a aggregate object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this aggregate.
          required: true
      - name: ipamaggregatesupdate
        method: PUT
        description: Put a aggregate object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this aggregate.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamaggregatespartialupdate
        method: PATCH
        description: Patch a aggregate object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this aggregate.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: ipamaggregatesdestroy
        method: DELETE
        description: Delete a aggregate object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this aggregate.
          required: true
    - name: api-ipam-asn-ranges
      path: /api/ipam/asn-ranges/
      operations:
      - name: ipamasnrangeslist
        method: GET
        description: Get a list of ASN range objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: description
          in: query
          type: array
        - name: description__empty
          in: query
          type: boolean
        - name: description__ic
          in: query
          type: array
        - name: description__ie
          in: query
          type: array
        - name: description__iew
          in: query
          type: array
        - name: description__iregex
          in: query
          type: array
        - name: description__isw
          in: query
          type: array
        - name: description__n
          in: query
          type: array
        - name: description__nic
          in: query
          type: array
        - name: description__nie
          in: query
          type: array
        - name: description__niew
          in: query
          type: array
        - name: description__nisw
          in: query
          type: array
        - name: description__regex
          in: query
          type: array
        - name: end
          in: query
          type: array
        - name: end__empty
          in: query
          type: boolean
        - name: end__gt
          in: query
          type: array
        - name: end__gte
          in: query
          type: array
        - name: end__lt
          in: query
          type: array
        - name: end__lte
          in: query
          type: array
        - name: end__n
          in: query
          type: array
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: modified_by_request
          in: query
          type: string
        - name: name
          in: query
          type: array
        - name: name__empty
          in: query
          type: boolean
        - name: name__ic
          in: query
          type: array
        - name: name__ie
          in: query
          type: array
        - name: name__iew
          in: query
          type: array
        - name: name__iregex
          in: query
          type: array
        - name: name__isw
          in: query
          type: array
        - name: name__n
          in: query
          type: array
        - name: name__nic
          in: query
          type: array
        - name: name__nie
          in: query
          type: array
        - name: name__niew
          in: query
          type: array
        - name: name__nisw
          in: query
          type: array
        - name: name__regex
          in: query
          type: array
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: owner
          in: query
          type: array
          description: Owner (name)
        - name: owner__n
          in: query
          type: array
          description: Owner (name)
        - name: owner_group
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group__n
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group_id
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_group_id__n
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_id
          in: query
          type: array
          description: Owner (ID)
        - name: owner_id__n
          in: query
          type: array
          description: Owner (ID)
        - name: q
          in: query
          type: string
          description: Search
        - name: rir
          in: query
          type: array
          description: RIR (slug)
        - name: rir__n
          in: query
          type: array
          description: RIR (slug)
        - name: rir_id
          in: query
          type: array
          description: RIR (ID)
        - name: rir_id__n
          in: query
          type: array
          description: RIR (ID)
        - name: slug
          in: query
          type: array
        - name: slug__empty
          in: query
          type: boolean
        - name: slug__ic
          in: query
          type: array
        - name: slug__ie
          in: query
          type: array
        - name: slug__iew
          in: query
          type: array
        - name: slug__iregex
          in: query
          type: array
        - name: slug__isw
          in: query
          type: array
        - name: slug__n
          in: query
          type: array
        - name: slug__nic
          in: query
          type: array
        - name: slug__nie
          in: query
          type: array
        - name: slug__niew
          in: query
          type: array
        - name: slug__nisw
          in: query
          type: array
        - name: slug__regex
          in: query
          type: array
        - name: start
          in: query
          type: array
        - name: start__empty
          in: query
          type: boolean
        - name: start__gt
          in: query
          type: array
        - name: start__gte
          in: query
          type: array
        - name: start__lt
          in: query
          type: array
        - name: start__lte
          in: query
          type: array
        - name: start__n
          in: query
          type: array
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: tenant
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant__n
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant_group
          in: query
          type: array
        - name: tenant_group__n
          in: query
          type: array
        - name: tenant_group_id
          in: query
          type: array
        - name: tenant_group_id__n
          in: query
          type: array
        - name: tenant_id
          in: query
          type: array
          description: Tenant (ID)
        - name: tenant_id__n
          in: query
          type: array
          description: Tenant (ID)
        - name: updated_by_request
          in: query
          type: string
      - name: ipamasnrangescreate
        method: POST
        description: Post a list of ASN range objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnrangesbulkupdate
        method: PUT
        description: Put a list of ASN range objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnrangesbulkpartialupdate
        method: PATCH
        description: Patch a list of ASN range objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnrangesbulkdestroy
        method: DELETE
        description: Delete a list of ASN range objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-ipam-asn-ranges-id
      path: /api/ipam/asn-ranges/{id}/
      operations:
      - name: ipamasnrangesretrieve
        method: GET
        description: Get a ASN range object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this ASN range.
          required: true
      - name: ipamasnrangesupdate
        method: PUT
        description: Put a ASN range object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this ASN range.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnrangespartialupdate
        method: PATCH
        description: Patch a ASN range object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this ASN range.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: ipamasnrangesdestroy
        method: DELETE
        description: Delete a ASN range object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this ASN range.
          required: true
    - name: api-ipam-asn-ranges-id-available-asns
      path: /api/ipam/asn-ranges/{id}/available-asns/
      operations:
      - name: ipamasnrangesavailableasnslist
        method: GET
        description: Get a ASN object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
      - name: ipamasnrangesavailableasnscreate
        method: POST
        description: Post a ASN object.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-ipam-asns
      path: /api/ipam/asns/
      operations:
      - name: ipamasnslist
        method: GET
        description: Get a list of ASN objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: asn
          in: query
          type: array
        - name: asn__empty
          in: query
          type: boolean
        - name: asn__gt
          in: query
          type: array
        - name: asn__gte
          in: query
          type: array
        - name: asn__lt
          in: query
          type: array
        - name: asn__lte
          in: query
          type: array
        - name: asn__n
          in: query
          type: array
        - name: created
          in: query
          type: array
        - name: created__empty
          in: query
          type: array
        - name: created__gt
          in: query
          type: array
        - name: created__gte
          in: query
          type: array
        - name: created__lt
          in: query
          type: array
        - name: created__lte
          in: query
          type: array
        - name: created__n
          in: query
          type: array
        - name: created_by_request
          in: query
          type: string
        - name: description
          in: query
          type: array
        - name: description__empty
          in: query
          type: boolean
        - name: description__ic
          in: query
          type: array
        - name: description__ie
          in: query
          type: array
        - name: description__iew
          in: query
          type: array
        - name: description__iregex
          in: query
          type: array
        - name: description__isw
          in: query
          type: array
        - name: description__n
          in: query
          type: array
        - name: description__nic
          in: query
          type: array
        - name: description__nie
          in: query
          type: array
        - name: description__niew
          in: query
          type: array
        - name: description__nisw
          in: query
          type: array
        - name: description__regex
          in: query
          type: array
        - name: id
          in: query
          type: array
        - name: id__empty
          in: query
          type: boolean
        - name: id__gt
          in: query
          type: array
        - name: id__gte
          in: query
          type: array
        - name: id__lt
          in: query
          type: array
        - name: id__lte
          in: query
          type: array
        - name: id__n
          in: query
          type: array
        - name: last_updated
          in: query
          type: array
        - name: last_updated__empty
          in: query
          type: array
        - name: last_updated__gt
          in: query
          type: array
        - name: last_updated__gte
          in: query
          type: array
        - name: last_updated__lt
          in: query
          type: array
        - name: last_updated__lte
          in: query
          type: array
        - name: last_updated__n
          in: query
          type: array
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: modified_by_request
          in: query
          type: string
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: owner
          in: query
          type: array
          description: Owner (name)
        - name: owner__n
          in: query
          type: array
          description: Owner (name)
        - name: owner_group
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group__n
          in: query
          type: array
          description: Owner Group (name)
        - name: owner_group_id
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_group_id__n
          in: query
          type: array
          description: Owner Group (ID)
        - name: owner_id
          in: query
          type: array
          description: Owner (ID)
        - name: owner_id__n
          in: query
          type: array
          description: Owner (ID)
        - name: provider
          in: query
          type: array
          description: Provider (slug)
        - name: provider__n
          in: query
          type: array
          description: Provider (slug)
        - name: provider_id
          in: query
          type: array
          description: Provider (ID)
        - name: provider_id__n
          in: query
          type: array
          description: Provider (ID)
        - name: q
          in: query
          type: string
          description: Search
        - name: rir
          in: query
          type: array
          description: RIR (slug)
        - name: rir__n
          in: query
          type: array
          description: RIR (slug)
        - name: rir_id
          in: query
          type: array
          description: RIR (ID)
        - name: rir_id__n
          in: query
          type: array
          description: RIR (ID)
        - name: site
          in: query
          type: array
          description: Site (slug)
        - name: site__n
          in: query
          type: array
          description: Site (slug)
        - name: site_group
          in: query
          type: array
        - name: site_group__n
          in: query
          type: array
        - name: site_group_id
          in: query
          type: array
        - name: site_group_id__n
          in: query
          type: array
        - name: site_id
          in: query
          type: array
          description: Site (ID)
        - name: site_id__n
          in: query
          type: array
          description: Site (ID)
        - name: tag
          in: query
          type: array
        - name: tag__n
          in: query
          type: array
        - name: tag_id
          in: query
          type: array
        - name: tag_id__n
          in: query
          type: array
        - name: tenant
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant__n
          in: query
          type: array
          description: Tenant (slug)
        - name: tenant_group
          in: query
          type: array
        - name: tenant_group__n
          in: query
          type: array
        - name: tenant_group_id
          in: query
          type: array
        - name: tenant_group_id__n
          in: query
          type: array
        - name: tenant_id
          in: query
          type: array
          description: Tenant (ID)
        - name: tenant_id__n
          in: query
          type: array
          description: Tenant (ID)
        - name: updated_by_request
          in: query
          type: string
      - name: ipamasnscreate
        method: POST
        description: Post a list of ASN objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnsbulkupdate
        method: PUT
        description: Put a list of ASN objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnsbulkpartialupdate
        method: PATCH
        description: Patch a list of ASN objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ipamasnsbulkdestroy
        method: DELETE
        description: Delete a list of ASN objects.
        outputRawFormat: json
        outputParameters:
        - name: result
         

# --- truncated at 32 KB (463 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/capabilities/netbox-ipam.yaml