NetBox wireless API
The wireless API from NetBox — 6 operation(s) for wireless.
NetBox wireless API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include wireless. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 27 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).
Requests are made against the base URL https://demo.netbox.dev/api.
27 operations
6 paths
32 schemas
6 DELETE6 GET6 PATCH3 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBox wireless 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 27
Across 6 paths, the API surfaces 27 operations — 6 DELETE, 6 GET, 6 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
wireless 27
GET
/api/wireless/wireless-lan-groups/
Get a list of wireless LAN group objects.
POST
/api/wireless/wireless-lan-groups/
Post a list of wireless LAN group objects.
PUT
/api/wireless/wireless-lan-groups/
Put a list of wireless LAN group objects.
PATCH
/api/wireless/wireless-lan-groups/
Patch a list of wireless LAN group objects.
DELETE
/api/wireless/wireless-lan-groups/
Delete a list of wireless LAN group objects.
GET
/api/wireless/wireless-lan-groups/{id}/
Get a wireless LAN group object.
PUT
/api/wireless/wireless-lan-groups/{id}/
Put a wireless LAN group object.
PATCH
/api/wireless/wireless-lan-groups/{id}/
Patch a wireless LAN group object.
DELETE
/api/wireless/wireless-lan-groups/{id}/
Delete a wireless LAN group object.
GET
/api/wireless/wireless-lans/
Get a list of wireless LAN objects.
POST
/api/wireless/wireless-lans/
Post a list of wireless LAN objects.
PUT
/api/wireless/wireless-lans/
Put a list of wireless LAN objects.
PATCH
/api/wireless/wireless-lans/
Patch a list of wireless LAN objects.
DELETE
/api/wireless/wireless-lans/
Delete a list of wireless LAN objects.
GET
/api/wireless/wireless-lans/{id}/
Get a wireless LAN object.
PUT
/api/wireless/wireless-lans/{id}/
Put a wireless LAN object.
PATCH
/api/wireless/wireless-lans/{id}/
Patch a wireless LAN object.
DELETE
/api/wireless/wireless-lans/{id}/
Delete a wireless LAN object.
GET
/api/wireless/wireless-links/
Get a list of wireless link objects.
POST
/api/wireless/wireless-links/
Post a list of wireless link objects.
PUT
/api/wireless/wireless-links/
Put a list of wireless link objects.
PATCH
/api/wireless/wireless-links/
Patch a list of wireless link objects.
DELETE
/api/wireless/wireless-links/
Delete a list of wireless link objects.
GET
/api/wireless/wireless-links/{id}/
Get a wireless link object.
PUT
/api/wireless/wireless-links/{id}/
Put a wireless link object.
PATCH
/api/wireless/wireless-links/{id}/
Patch a wireless link object.
DELETE
/api/wireless/wireless-links/{id}/
Delete a wireless link object.
Schemas 32
The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are WirelessLAN (22 properties), WirelessLink (21 properties), WirelessLANGroup (16 properties), PatchedWritableWirelessLANRequest (15 properties). Each schema is shown below with its type and property counts.
WirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefWirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
7 required
PatchedWritableWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
PaginatedWirelessLinkList
object
4 properties
2 required
WirelessLink
object
Base serializer class for models inheriting from PrimaryModel.
21 properties
8 required
WirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
16 properties
10 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
NestedWirelessLANGroupRequest
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…
2 properties
2 required
WritableWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
1 required
NestedWirelessLANGroup
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
7 required
BriefWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties
2 required
PaginatedWirelessLANGroupList
object
4 properties
2 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties
2 required
WirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
1 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
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 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
WirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
2 required
PaginatedWirelessLANList
object
4 properties
2 required
BriefInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties
7 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
PatchedWritableWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
PatchedWritableWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties
5 required
WirelessLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties
8 required
WritableWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
2 required
BriefInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties
2 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
BriefVLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties
2 required
WritableWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
2 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBox 12
Other APIs NetBox publishes across the network.
NetBox GraphQL API
NetBox authentication-check API
NetBox circuits API
NetBox core API
NetBox dcim API
NetBox extras API
NetBox ipam API
NetBox schema API
NetBox status API
NetBox tenancy API
NetBox users API
NetBox virtualization API
#wireless