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 wireless API

The wireless API from NetBox Labs — 6 operation(s) for wireless.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox Labs wireless 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 wireless. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 27 operations across 6 paths, and defines 38 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/.

27 operations 6 paths 38 schemas 6 DELETE6 GET6 PATCH3 POST6 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 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.
wireless_wireless_lan_groups_list 91 params → 200
POST
/api/wireless/wireless-lan-groups/
Post a list of wireless LAN group objects.
wireless_wireless_lan_groups_create body → 201
PUT
/api/wireless/wireless-lan-groups/
Put a list of wireless LAN group objects.
wireless_wireless_lan_groups_bulk_update body → 200
PATCH
/api/wireless/wireless-lan-groups/
Patch a list of wireless LAN group objects.
wireless_wireless_lan_groups_bulk_partial_update body → 200
DELETE
/api/wireless/wireless-lan-groups/
Delete a list of wireless LAN group objects.
wireless_wireless_lan_groups_bulk_destroy body → 204
GET
/api/wireless/wireless-lan-groups/{id}/
Get a wireless LAN group object.
wireless_wireless_lan_groups_retrieve 4 params → 200
PUT
/api/wireless/wireless-lan-groups/{id}/
Put a wireless LAN group object.
wireless_wireless_lan_groups_update 1 param body → 200
PATCH
/api/wireless/wireless-lan-groups/{id}/
Patch a wireless LAN group object.
wireless_wireless_lan_groups_partial_update 1 param body → 200
DELETE
/api/wireless/wireless-lan-groups/{id}/
Delete a wireless LAN group object.
wireless_wireless_lan_groups_destroy 1 param → 204
GET
/api/wireless/wireless-lans/
Get a list of wireless LAN objects.
wireless_wireless_lans_list 163 params → 200
POST
/api/wireless/wireless-lans/
Post a list of wireless LAN objects.
wireless_wireless_lans_create body → 201
PUT
/api/wireless/wireless-lans/
Put a list of wireless LAN objects.
wireless_wireless_lans_bulk_update body → 200
PATCH
/api/wireless/wireless-lans/
Patch a list of wireless LAN objects.
wireless_wireless_lans_bulk_partial_update body → 200
DELETE
/api/wireless/wireless-lans/
Delete a list of wireless LAN objects.
wireless_wireless_lans_bulk_destroy body → 204
GET
/api/wireless/wireless-lans/{id}/
Get a wireless LAN object.
wireless_wireless_lans_retrieve 4 params → 200
PUT
/api/wireless/wireless-lans/{id}/
Put a wireless LAN object.
wireless_wireless_lans_update 1 param body → 200
PATCH
/api/wireless/wireless-lans/{id}/
Patch a wireless LAN object.
wireless_wireless_lans_partial_update 1 param body → 200
DELETE
/api/wireless/wireless-lans/{id}/
Delete a wireless LAN object.
wireless_wireless_lans_destroy 1 param → 204
GET
/api/wireless/wireless-links/
Get a list of wireless link objects.
wireless_wireless_links_list 154 params → 200
POST
/api/wireless/wireless-links/
Post a list of wireless link objects.
wireless_wireless_links_create body → 201
PUT
/api/wireless/wireless-links/
Put a list of wireless link objects.
wireless_wireless_links_bulk_update body → 200
PATCH
/api/wireless/wireless-links/
Patch a list of wireless link objects.
wireless_wireless_links_bulk_partial_update body → 200
DELETE
/api/wireless/wireless-links/
Delete a list of wireless link objects.
wireless_wireless_links_bulk_destroy body → 204
GET
/api/wireless/wireless-links/{id}/
Get a wireless link object.
wireless_wireless_links_retrieve 4 params → 200
PUT
/api/wireless/wireless-links/{id}/
Put a wireless link object.
wireless_wireless_links_update 1 param body → 200
PATCH
/api/wireless/wireless-links/{id}/
Patch a wireless link object.
wireless_wireless_links_partial_update 1 param body → 200
DELETE
/api/wireless/wireless-links/{id}/
Delete a wireless link object.
wireless_wireless_links_destroy 1 param → 204

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are WirelessLAN (22 properties), WirelessLink (21 properties), BulkWirelessLinkRequest (16 properties), PatchedBulkWirelessLANRequest (16 properties). Each schema is shown below with its type and property counts.

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
PatchedWritableWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
PatchedBulkWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 1 required
PaginatedWirelessLinkList
object
4 properties 2 required
BriefDeviceRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties
BriefWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
3 properties 2 required
BriefVLAN
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BulkWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 2 required
WritableWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 2 required
BulkWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 3 required
BriefInterfaceRequest
object
Adds an owner field for models which have a ForeignKey to users.Owner.
3 properties 2 required
BriefWirelessLANGroup
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 7 required
PatchedWritableWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties
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
BriefInterface
object
Adds an owner field for models which have a ForeignKey to users.Owner.
8 properties 7 required
WirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
WirelessLink
object
Base serializer class for models inheriting from PrimaryModel.
21 properties 8 required
WirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
BriefCable
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
BriefDevice
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 3 required
WirelessLAN
object
Base serializer class for models inheriting from PrimaryModel.
22 properties 8 required
PatchedBulkWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
9 properties 1 required
WritableWirelessLANRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 1 required
WritableWirelessLANGroupRequest
object
Base serializer class for models inheriting from NestedGroupModel.
8 properties 2 required
PaginatedWirelessLANList
object
4 properties 2 required
BriefVLANRequest
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
BulkWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 3 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
PatchedBulkWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 1 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PaginatedWirelessLANGroupList
object
4 properties 2 required
WirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 2 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
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
PatchedWritableWirelessLinkRequest
object
Base serializer class for models inheriting from PrimaryModel.
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-wireless-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 ipam 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
#wireless
← Back to N APIs
API Details
ID
netbox-labs:netbox-labs-wireless-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