NetBox wireless API
The wireless API from NetBox — 6 operation(s) for wireless.
OpenAPI Specification
openapi: 3.0.3
info:
title: NetBox REST authentication-check wireless API
version: 4.5.9 (4.5)
license:
name: Apache v2 License
servers:
- url: ''
description: NetBox
tags:
- name: wireless
paths:
/api/wireless/wireless-lan-groups/:
get:
operationId: wireless_wireless_lan_groups_list
description: Get a list of wireless LAN group objects.
parameters:
- in: query
name: ancestor
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ancestor__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ancestor_id
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: ancestor_id__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__empty
schema:
type: boolean
- in: query
name: description__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: description__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: id
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__empty
schema:
type: boolean
- in: query
name: id__gt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__gte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lt
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__lte
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: id__n
schema:
type: array
items:
type: integer
format: int32
explode: true
style: form
- in: query
name: last_updated
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: last_updated__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- name: limit
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: modified_by_request
schema:
type: string
format: uuid
- in: query
name: name
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__empty
schema:
type: boolean
- in: query
name: name__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: name__regex
schema:
type: array
items:
type: string
explode: true
style: form
- name: offset
required: false
in: query
description: The initial index from which to return the results.
schema:
type: integer
- name: ordering
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- in: query
name: owner
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner__n
schema:
type: array
items:
type: string
description: Owner (name)
explode: true
style: form
- in: query
name: owner_group
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group__n
schema:
type: array
items:
type: string
description: Owner Group (name)
explode: true
style: form
- in: query
name: owner_group_id
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_group_id__n
schema:
type: array
items:
type: integer
description: Owner Group (ID)
explode: true
style: form
- in: query
name: owner_id
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: owner_id__n
schema:
type: array
items:
type: integer
nullable: true
description: Owner (ID)
explode: true
style: form
- in: query
name: parent
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: parent__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: parent_id
schema:
type: array
items:
type: integer
nullable: true
explode: true
style: form
- in: query
name: parent_id__n
schema:
type: array
items:
type: integer
nullable: true
explode: true
style: form
- in: query
name: q
schema:
type: string
description: Search
- in: query
name: slug
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__empty
schema:
type: boolean
- in: query
name: slug__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: slug__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: tag_id
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: tag_id__n
schema:
type: array
items:
type: integer
explode: true
style: form
- in: query
name: updated_by_request
schema:
type: string
format: uuid
tags:
- wireless
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedWirelessLANGroupList'
description: ''
post:
operationId: wireless_wireless_lan_groups_create
description: Post a list of wireless LAN group objects.
tags:
- wireless
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/WritableWirelessLANGroupRequest'
- type: array
items:
$ref: '#/components/schemas/WritableWirelessLANGroupRequest'
multipart/form-data:
schema:
oneOf:
- $ref: '#/components/schemas/WritableWirelessLANGroupRequest'
- type: array
items:
$ref: '#/components/schemas/WritableWirelessLANGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
put:
operationId: wireless_wireless_lan_groups_bulk_update
description: Put a list of wireless LAN group objects.
tags:
- wireless
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
patch:
operationId: wireless_wireless_lan_groups_bulk_partial_update
description: Patch a list of wireless LAN group objects.
tags:
- wireless
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
delete:
operationId: wireless_wireless_lan_groups_bulk_destroy
description: Delete a list of wireless LAN group objects.
tags:
- wireless
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/WirelessLANGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/wireless/wireless-lan-groups/{id}/:
get:
operationId: wireless_wireless_lan_groups_retrieve
description: Get a wireless LAN group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this wireless LAN group.
required: true
tags:
- wireless
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
put:
operationId: wireless_wireless_lan_groups_update
description: Put a wireless LAN group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this wireless LAN group.
required: true
tags:
- wireless
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WritableWirelessLANGroupRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableWirelessLANGroupRequest'
required: true
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
patch:
operationId: wireless_wireless_lan_groups_partial_update
description: Patch a wireless LAN group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this wireless LAN group.
required: true
tags:
- wireless
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableWirelessLANGroupRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableWirelessLANGroupRequest'
security:
- cookieAuth: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WirelessLANGroup'
description: ''
delete:
operationId: wireless_wireless_lan_groups_destroy
description: Delete a wireless LAN group object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this wireless LAN group.
required: true
tags:
- wireless
security:
- cookieAuth: []
- tokenAuth: []
responses:
'204':
description: No response body
/api/wireless/wireless-lans/:
get:
operationId: wireless_wireless_lans_list
description: Get a list of wireless LAN objects.
parameters:
- in: query
name: auth_cipher
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__empty
schema:
type: boolean
- in: query
name: auth_cipher__ic
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__ie
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__iew
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__isw
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__n
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__nic
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__nie
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__niew
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_cipher__regex
schema:
type: array
items:
type: string
x-spec-enum-id: 42f867e89988bb0c
nullable: true
title: Authentication cipher
explode: true
style: form
- in: query
name: auth_psk
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__empty
schema:
type: boolean
- in: query
name: auth_psk__ic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__ie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__iew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__iregex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__isw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__n
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__nic
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__nie
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__niew
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__nisw
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_psk__regex
schema:
type: array
items:
type: string
explode: true
style: form
- in: query
name: auth_type
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__empty
schema:
type: boolean
- in: query
name: auth_type__ic
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__ie
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__iew
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__iregex
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__isw
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__n
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__nic
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__nie
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__niew
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__nisw
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: auth_type__regex
schema:
type: array
items:
type: string
x-spec-enum-id: e917c12aac765910
nullable: true
title: Authentication type
explode: true
style: form
- in: query
name: created
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__empty
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__gte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lt
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__lte
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created__n
schema:
type: array
items:
type: string
format: date-time
explode: true
style: form
- in: query
name: created_by_request
schema:
type: string
format: uuid
- in: query
name: description
schema:
type: array
items:
type: string
explode: true
style: form
# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox/refs/heads/main/openapi/netbox-wireless-api-openapi.yml