openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2604.1.1**
>
> Date: **May 13, 2026**
NOTE:
Some important API changes will be introduced. Please make sure to read the
announcements
---
## Additional Documentation
* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)
## Helpful Resources
* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)
## Mist Web Browser Extension:
* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)
---'
license:
name: MIT
url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
title: Mist Admins Sites Devices API
version: 2604.1.1
x-logo:
altText: Juniper-MistAI
backgroundColor: '#FFFFFF'
url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
url: https://api.mist.com
- description: Mist Global 02
url: https://api.gc1.mist.com
- description: Mist Global 03
url: https://api.ac2.mist.com
- description: Mist Global 04
url: https://api.gc2.mist.com
- description: Mist Global 05
url: https://api.gc4.mist.com
- description: Mist EMEA 01
url: https://api.eu.mist.com
- description: Mist EMEA 02
url: https://api.gc3.mist.com
- description: Mist EMEA 03
url: https://api.ac6.mist.com
- description: Mist EMEA 04
url: https://api.gc6.mist.com
- description: Mist APAC 01
url: https://api.ac5.mist.com
- description: Mist APAC 02
url: https://api.gc5.mist.com
- description: Mist APAC 03
url: https://api.gc7.mist.com
security:
- apiToken: []
- basicAuth: []
- basicAuth: []
csrfToken: []
tags:
- description: 'Mist provides many ways (device_type specific template, site template, device profile, per-device) to configure devices for different kind of scenarios.
The precedence goes from most specific to least specific
Device > Device Profile > RFTemplate (for AP only) > DeviceType-specific Template > Site Template > Site Setting'
name: Sites Devices
paths:
/api/v1/sites/{site_id}/devices:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get list of devices on the site.
operationId: listSiteDevices
parameters:
- in: query
name: type
schema:
$ref: '#/components/schemas/device_type_with_all'
- $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/page'
responses:
'200':
$ref: '#/components/responses/DevicesArray'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: listSiteDevices
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/config_history/count:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Counts the number of entries in device config history for distinct field with given filters
operationId: countSiteDeviceConfigHistory
parameters:
- in: query
name: distinct
schema:
type: string
- in: query
name: mac
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: countSiteDeviceConfigHistory
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/config_history/search:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Search for entries in device config history
operationId: searchSiteDeviceConfigHistory
parameters:
- in: query
name: type
schema:
$ref: '#/components/schemas/device_type_default_ap'
- description: Device MAC Address
in: query
name: mac
schema:
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/ConfigsHistorySearch'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: searchSiteDeviceConfigHistory
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/count:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Counts the number of entries in ap events history for distinct field with given filters
operationId: countSiteDevices
parameters:
- in: query
name: distinct
schema:
$ref: '#/components/schemas/site_devices_count_distinct'
- in: query
name: hostname
schema:
type: string
- in: query
name: model
schema:
type: string
- in: query
name: mac
schema:
type: string
- in: query
name: version
schema:
type: string
- in: query
name: mxtunnel_status
schema:
type: string
- in: query
name: mxedge_id
schema:
type: string
- in: query
name: lldp_system_name
schema:
type: string
- in: query
name: lldp_system_desc
schema:
type: string
- in: query
name: lldp_port_id
schema:
type: string
- in: query
name: lldp_mgmt_addr
schema:
type: string
- in: query
name: map_id
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: countSiteDevices
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/events/count:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Counts the number of entries in ap events history for distinct field with given filters
operationId: countSiteDeviceEvents
parameters:
- in: query
name: distinct
schema:
$ref: '#/components/schemas/site_device_events_count_distinct'
- in: query
name: model
schema:
type: string
- $ref: '#/components/parameters/device_event_type'
- in: query
name: type_code
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: countSiteDeviceEvents
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/events/search:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Search Devices Events
operationId: searchSiteDeviceEvents
parameters:
- description: Device mac
in: query
name: mac
schema:
type: string
- description: Device model
in: query
name: model
schema:
type: string
- description: Event message
in: query
name: text
schema:
type: string
- description: Event time
in: query
name: timestamp
schema:
type: string
- $ref: '#/components/parameters/device_event_type'
- description: Return last/recent event for passed in field
example: port_id
in: query
name: last_by
schema:
type: string
- description: Keyword to include events from additional indices (e.g. ext_tunnel for prisma events)
in: query
name: includes
schema:
examples:
- ext_tunnel
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/EventsDevices'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: searchSiteDeviceEvents
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/export:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: To download the exported device information
operationId: exportSiteDevices
responses:
'200':
$ref: '#/components/responses/File'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: exportSiteDevices
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/gbp_tag:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: Set GBP Tag for multiple devices
operationId: setSiteDevicesGbpTag
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/devices_gbp_tag'
description: Request Body
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: setSiteDevicesGbpTag
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/import:
parameters:
- $ref: '#/components/parameters/site_id'
post:
description: 'Import Information for Multiple Devices
CSV format:
```csv
mac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled
5c5b53010101,"AP 1",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,"guest, campus, vip",1,20,0,false,0,40,0,false,17,80,0,false
```'
operationId: importSiteDevices
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ap_import_json'
multipart/form-data:
schema:
$ref: '#/components/schemas/binary_stream'
responses:
'200':
$ref: '#/components/responses/DevicesArray'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: importSiteDevices
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/last_config/count:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Counts the number of entries in device config history for distinct field with given filters
operationId: countSiteDeviceLastConfig
parameters:
- in: query
name: distinct
schema:
$ref: '#/components/schemas/site_device_last_config_count_distinct'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
responses:
'200':
$ref: '#/components/responses/Count'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: countSiteDeviceLastConfig
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/last_config/search:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Search Device Last Configs
operationId: searchSiteDeviceLastConfigs
parameters:
- description: 'Duration for expiring cert queries (format: 2d/3h/172800 seconds)'
in: query
name: cert_expiry_duration
schema:
examples:
- 2d
type: string
- in: query
name: device_type
schema:
$ref: '#/components/schemas/last_config_device_type'
- in: query
name: mac
schema:
type: string
- in: query
name: version
schema:
type: string
- in: query
name: name
schema:
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/ConfigsHistorySearch'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: searchSiteDeviceLastConfigs
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/search:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Search Device
operationId: searchSiteDevices
parameters:
- description: When `type`==`ap`, Channel of band_24
in: query
name: band_24_channel
schema:
type: integer
- description: When `type`==`ap`, Channel of band_5
in: query
name: band_5_channel
schema:
type: integer
- description: When `type`==`ap`, Channel of band_6
in: query
name: band_6_channel
schema:
type: integer
- description: When `type`==`ap`, Bandwidth of band_24
in: query
name: band_24_bandwidth
schema:
type: integer
- description: When `type`==`ap`, Bandwidth of band_5
in: query
name: band_5_bandwidth
schema:
type: integer
- description: When `type`==`ap`, Bandwidth of band_6
in: query
name: band_6_bandwidth
schema:
type: integer
- description: When `type`==`ap`, Power of band_24
in: query
name: band_24_power
schema:
type: integer
- description: When `type`==`ap`, Power of band_5
in: query
name: band_5_power
schema:
type: integer
- description: When `type`==`ap`, Power of band_6
in: query
name: band_6_power
schema:
type: integer
- description: When `type`==`gateway`, true / false
in: query
name: clustered
schema:
type: boolean
- description: When `type`==`ap`, Port speed of eth0
in: query
name: eth0_port_speed
schema:
examples:
- 100
- 1000
type: integer
- description: When `type`==`switch`, EVPN topology id
in: query
name: evpntopo_id
schema:
format: uuid
type: string
- $ref: '#/components/parameters/partial_filter_ext_ip'
- $ref: '#/components/parameters/partial_filter_hostname_device'
- $ref: '#/components/parameters/partial_filter_ip_device'
- description: When `type`==`switch` or `type`==`gateway`, last configuration status
in: query
name: last_config_status
schema:
examples:
- success
type: string
- description: Last hostname of the device.
in: query
name: last_hostname
schema:
type: string
- description: When `type`==`ap`, LLDP management ip address
in: query
name: lldp_mgmt_addr
schema:
type: string
- $ref: '#/components/parameters/partial_filter_lldp_port_id'
- $ref: '#/components/parameters/partial_filter_lldp_system_desc'
- $ref: '#/components/parameters/partial_filter_lldp_system_name'
- $ref: '#/components/parameters/partial_filter_mac_device'
- $ref: '#/components/parameters/partial_filter_model'
- description: When `type`==`ap`, Mist Edge id, if AP is connecting to a Mist Edge
in: query
name: mxedge_id
schema:
format: uuid
type: string
- description: When `type`==`ap`, Comma separated list of Mist Edge id, if AP is connecting to a Mist Edge
in: query
name: mxedge_ids
schema:
type: string
- description: When `type`==`ap`, MxTunnel status, up / down.
in: query
name: mxtunnel_status
schema:
$ref: '#/components/schemas/search_site_devices_mxtunnel_status'
- description: 'When `type`==`gateway`. enum: `node0`, `node1`'
in: query
name: node
schema:
$ref: '#/components/schemas/ha_cluster_node_enum'
- description: When `type`==`gateway`, node0 MAC Address
in: query
name: node0_mac
schema:
type: string
- description: When `type`==`gateway`, node1 MAC Address
in: query
name: node1_mac
schema:
type: string
- description: When `type`==`ap`, whether the AP is power constrained
in: query
name: power_constrained
schema:
type: boolean
- description: "When `type`==`switch` or `type`==`gateway`, Key-value pairs where the key\nis the RADIUS server address and the value contains authentication statistics:\n * (string): IP address of the RADIUS server as the key\n * `auth_accepts` (long): Number of accepted authentication requests\n * `auth_rejects` (long): Number of rejected authentication requests\n * `auth_timeouts` (long): Number of authentication timeouts\n * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`"
in: query
name: radius_stats
schema:
type: string
- description: Whether to return device stats
in: query
name: stats
schema:
default: false
type: boolean
- description: When `type`==`gateway` (SSR only), version of 128T agent
in: query
name: t128agent_version
schema:
type: string
- $ref: '#/components/parameters/device_type'
- description: Version
in: query
name: version
schema:
type: string
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- description: Sort options
in: query
name: sort
schema:
$ref: '#/components/schemas/search_site_devices_sort'
- description: Sort options in reverse order
in: query
name: desc_sort
schema:
$ref: '#/components/schemas/search_site_devices_desc_sort'
- $ref: '#/components/parameters/search_after'
responses:
'200':
$ref: '#/components/responses/DevicesSearch'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: searchSiteDevices
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/{device_id}:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
get:
description: Get Device Configuration
operationId: getSiteDevice
responses:
'200':
$ref: '#/components/responses/Device'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: getSiteDevice
tags:
- Sites Devices
put:
description: Update Device Configuration
operationId: updateSiteDevice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mist_device'
description: Request Body
responses:
'200':
$ref: '#/components/responses/Device'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: updateSiteDevice
tags:
- Sites Devices
/api/v1/sites/{site_id}/devices/{device_id}/image/{image_number}:
parameters:
- $ref: '#/components/parameters/site_id'
- $ref: '#/components/parameters/device_id'
- in: path
name: image_number
required: true
schema:
type: integer
delete:
description: Delete image from a device
operationId: deleteSiteDeviceImage
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: deleteSiteDeviceImage
tags:
- Sites Devices
post:
description: Attach up to 3 images to a device
operationId: addSiteDeviceImage
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/image_import'
description: Request Body
responses:
'200':
$ref: '#/components/responses/OK'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: addSiteDeviceImage
tags:
- Sites Devices
components:
schemas:
protect_re_custom_protocol:
default: any
description: 'enum: `any`, `icmp`, `tcp`, `udp`'
enum:
- any
- icmp
- tcp
- udp
type: string
switch_port_local_usage_dynamic_vlan_networks:
description: Only if `port_auth`==`dot1x`, if dynamic vlan is used, specify the possible networks/vlans RADIUS can return
examples:
- - corp
- user
items:
type: string
type: array
service_policy_ewf_rule_profile:
default: strict
description: 'enum: `critical`, `standard`, `strict`'
enum:
- critical
- standard
- strict
type: string
strings:
items:
type: string
type: array
uniqueItems: true
mist_device:
discriminator:
mapping:
ap: '#/components/schemas/device_ap'
gateway: '#/components/schemas/device_gateway'
switch: '#/components/schemas/device_switch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/device_ap'
- $ref: '#/components/schemas/device_switch'
- $ref: '#/components/schemas/device_gateway'
network_internal_access:
additionalProperties: false
properties:
enabled:
type: boolean
type: object
app_probing_apps:
description: APp-keys from [List Applications](/#operations/listApplications)
examples:
- - facebook
items:
type: string
type: array
app_probing_custom_app:
additionalProperties: false
properties:
address:
description: Required if `protocol`==`icmp`
examples:
- 192.168.1.1
type: string
app_type:
type: string
hostnames:
$ref: '#/components/schemas/app_probing_custom_app_hostname'
key:
type: string
name:
examples:
- pos_app
type: string
network:
examples:
- lan
type: string
packetSize:
description: If `protocol`==`icmp`
maximum: 65400
minimum: 0
type: integer
protocol:
$ref: '#/components/schemas/app_probing_custom_app_protocol'
url:
description: If `protocol`==`http`
examples:
- www.abc.com
type: string
vrf:
examples:
- lan
type: string
type: object
tunnel_config_node_remote_ids:
description: Only if `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
items:
type: string
type: array
network_internet_access:
additionalProperties: false
description: Whether this network has direct internet access
properties:
create_simple_service_policy:
default: false
type: boolean
destination_nat:
$ref: '#/components/schemas/network_internet_access_destination_nat'
enabled:
type: boolean
restricted:
default: false
description: By default, all access is allowed, to only allow certain traffic, make `restricted`=`true` and define service_policies
type: boolean
static_nat:
$ref: '#/components/schemas/network_internet_access_static_nat'
type: object
gw_routing_policy_term:
additionalProperties: false
properties:
actions:
$ref: '#/components/schemas/gw_routing_policy_term_action'
matching:
$ref: '#/components/schemas/gw_routing_policy_term_matching'
type: object
service_policy_secintel_profile:
default: default
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
gateway_extra_route6:
additionalProperties: false
properties:
via:
format: ipv6
type: string
type: object
switch_bgp_config_networks:
description: List of network names for BGP configuration. When a network is specified, a BGP group will be added to the VRF that network is part of.
items:
type: string
type: array
tunnel_config:
additionalProperties: false
properties:
auto_provision:
$ref: '#/components/schemas/tunnel_config_auto_provision'
ike_lifetime:
description: Only if `provider`==`custom-ipsec`
type: integer
ike_mode:
$ref: '#/components/schemas/tunnel_config_ike_mode'
ike_proposals:
$ref: '#/components/schemas/tunnel_config_ike_proposals'
ipsec_lifetime:
description: If `provider`==`custom-ipsec`
type: integer
ipsec_proposals:
$ref: '#/components/schemas/tunnel_config_ipsec_proposals'
local_id:
description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
type: string
local_subnets:
$ref: '#/components/schemas/tunnel_config_local_subnets'
mode:
$ref: '#/components/schemas/tunnel_config_tunnel_mode'
networks:
$ref: '#/components/schemas/tunnel_config_networks'
primary:
$ref: '#/components/schemas/tunnel_config_node'
probe:
$ref: '#/components/schemas/tunnel_config_probe'
protocol:
$ref: '#/components/schemas/tunnel_config_protocol'
provider:
$ref: '#/components/schemas/tunnel_config_provider'
psk:
description: Required if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
type: string
remote_subnets:
$ref: '#/components/schemas/tunnel_config_remote_subnets'
secondary:
$ref: '#/components/schemas/tunnel_config_node'
version:
$ref: '#/components/schemas/tunnel_config_version'
type: object
sw_routing_policy_term_matching:
additionalProperties: false
description: zero or more criteria/filter can be specified to match the term, all criteria have to be met
properties:
as_path:
$ref: '#/components/schemas/routing_policy_term_matching_as_path'
community:
$ref: '#/components/schemas/routing_policy_term_matching_community'
prefix:
$ref: '#/components/schemas/routing_policy_term_matching_prefix'
protocol:
$ref: '#/components/schemas/sw_routing_policy_term_matching_protocol'
type: object
app_probing_custom_app_protocol:
default: http
description: 'enum: `http`, `icmp`'
enum:
- http
- icmp
type: string
switch_bgp_config_hold_time:
description: Hold time is three times the interval at which keepalive messages are sent. It indicates to the peer the length of time that it should consider the sender valid. Must be 0 or a number in the range 3-65535.
oneOf:
- $ref: '#/components/schemas/switch_bgp_config_hold_time_zero'
- $ref: '#/components/schemas/switch_bgp_config_hold_time_integer'
gw_routing_policy_terms:
description: zero or more criteria/filter can be specified to match the term, all criteria have to be met
items:
$ref: '#/components/schemas/gw_routing_policy_term'
type: array
uniqueItems: true
tunnel_config_tunnel_mode:
default: active-standby
description: 'Required if `provider`==`zscaler-gre`, `provider`==`jse-ipsec`. enum: `active-active`, `active-standby`'
enum:
- active-active
- active-standby
type: string
gateway_port_dsl_type:
default: vdsl
description: 'if `wan_type`==`dsl`. enum: `adsl`, `vdsl`'
enum:
- adsl
- vdsl
type: string
ap_centrak:
additionalProperties: false
properties:
enabled:
default: false
type: boolean
type: object
acl_policy_src_tags:
description: "ACL Policy Source Tags:\n - for GBP-based policy, all src_tags and dst_tags have to be gbp-based\n - for ACL-based policy, `network` is required in either the source or destination so that we know where to attach the policy to"
items:
examples:
- macs
type: string
type: array
snmpv3_config_target_address:
items:
$ref: '#/components/schemas/snmpv3_config_target_address_item'
type: array
acl_tags:
additionalProperties:
$ref: '#/components/schemas/acl_tag'
description: ACL Tags to identify traffic source or destination. Key name is the tag name
type: object
switch_virtual_chassis_member:
additionalProperties: false
properties:
mac:
description: fpc0, same as the mac of device_id
examples:
- aff827549235
type: string
member_id:
type: integer
vc_role:
$ref: '#/components/schemas/switch_virtual_chassis_member_vc_role'
required:
- mac
- member_id
- vc_role
type: object
tacacs_default_role:
default: none
description: 'enum: `admin`, `helpdesk`, `none`, `read`'
enum:
- admin
- helpdesk
- none
- read
type: string
switch_port_usage_mac_auth_protocol:
default: eap-md5
description: 'Only if `mode`!=`dynamic` and `enable_mac_auth` ==`true`. This type is ignored if mist_nac is enabled. enum: `eap-md5`, `eap-peap`, `pap`'
enum:
- eap-md5
- eap-peap
- pap
type: string
gateway_port_config_ip_config:
additionalProperties: false
description: Junos IP Config
properties:
dns:
$ref: '#/components/schemas/gateway_ip_config_dns_servers'
dns_suffix:
$ref: '#/components/schemas/gateway_ip_config_dns_suffix'
gateway:
description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IP Address (i.e. "192.168.1.1") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.1.1
type: string
gateway6:
description: Except for out-of_band interface (vme/em0/fxp0). Interface Default Gateway IPv6 Address (i.e. "2001:db8::1") or a Variable (i.e. "{{myvar}}")
examples:
- 2001:db8::1
type: string
ip:
description: Interface IP Address (i.e. "192.168.1.8") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.1.8
format: ipv4
type: string
ip6:
description: Interface IPv6 Address (i.e. "2001:db8::123") or a Variable (i.e. "{{myvar}}")
examples:
- 2001:db8::123
format: ipv6
type: string
netmask:
description: Used only if `subnet` is not specified in `networks`. Interface Netmask (i.e. "/24") or a Variable (i.e. "{{myvar}}")
examples:
- /24
type: string
netmask6:
description: Used only if `subnet` is not specified in `networks`. Interface IPv6 Netmask (i.e. "/64") or a Variable (i.e. "{{myvar}}")
examples:
- /64
type: string
network:
description: Optional, the network to be used for mgmt
type: string
poser_password:
description: If `type`==`pppoe`
type: string
pppoe_auth:
$ref: '#/components/schemas/gateway_wan_ppoe_auth'
pppoe_username:
description: If `type`==`pppoe`
type: string
type:
$ref: '#/components/schemas/gateway_wan_type'
type6:
$ref: '#/components/schemas/gateway_wan_type6'
type: object
gateway_wan_probe_override:
additionalProperties: false
description: Only if `usage`==`wan`
properties:
ip6s:
$ref: '#/components/schemas/strings'
ips:
$ref: '#/components/schemas/strings'
probe_profile:
$ref: '#/components/schemas/gateway_wan_probe_override_probe_profile'
type: object
snmp_vacm_access_item_prefix_list_item_level:
description: 'enum: `authentication`, `none`, `privacy`'
enum:
- authentication
- none
- privacy
type: string
radsec_servers:
description: List of RadSec Servers. Only if not Mist Edge.
items:
$ref: '#/components/schemas/radsec_server'
type: array
uniqueItems: true
switch_port_local_usage_mode:
description: 'enum: `access`, `inet`, `trunk`'
enum:
- access
- inet
- trunk
type: string
app_probing_custom_app_hostname:
description: If `protocol`==`http`
examples:
- - https://www.abc.com
items:
type: string
type: array
extra_route:
additionalProperties: false
properties:
discard:
default: false
description: This takes precedence
type: boolean
metric:
examples:
- null
maximum: 2147483647
minimum: 0
type:
- integer
- 'null'
next_qualified:
additionalProperties:
$ref: '#/components/schemas/extra_route_next_qualified_properties'
examples:
- 10.3.1.1:
metric: null
preference: 40
type: object
no_resolve:
default: false
type: boolean
preference:
examples:
- 30
maximum: 2147483647
minimum: 0
type:
- integer
- 'null'
via:
$ref: '#/components/schemas/next_hop_via'
type: object
device_event:
additionalProperties: false
properties:
ap:
description: (will be deprecated soon; please use mac instead) ap mac
type: string
ap_name:
description: (will be deprecated soon; please use device_name instead) ap name
type: string
apfw:
type: string
audit_id:
$ref: '#/components/schemas/id'
bandwidth:
type: integer
channel:
type: integer
chassis_mac:
type: string
count:
type: integer
device_name:
description: Device name
type: string
device_type:
$ref: '#/components/schemas/device_type'
ev_type:
$ref: '#/components/schemas/webhook_device_events_event_ev_type'
ext_ip:
type: string
mac:
description: Device mac
type: string
model:
type: string
node:
type: string
org_id:
$ref: '#/components/schemas/org_id'
port_id:
type: string
power:
type: integer
pre_bandwidth:
type: integer
pre_channel:
type: integer
pre_power:
type: integer
pre_usage:
type: integer
reason:
description: (optional) event reason
type: string
site_id:
$ref: '#/components/schemas/site_id'
site_name:
description: Site name
type: string
text:
description: (optional) event description
type: string
timestamp:
$ref: '#/components/schemas/timestamp'
type:
description: Event type
type: string
usage:
type: integer
version:
type: string
required:
- org_id
- timestamp
- type
type: object
gw_routing_policy_term_action_add_community:
items:
examples:
- '3900190'
type: string
type: array
gateway_port_lte_auth:
default: none
description: 'if `wan_type`==`lte`. enum: `chap`, `none`, `pap`'
enum:
- chap
- none
- pap
type: string
gateway_port_mirroring_port_mirror:
additionalProperties: false
properties:
family_type:
type: string
ingress_port_ids:
$ref: '#/components/schemas/gateway_port_mirroring_ingress_port_ids'
output_port_id:
examples:
- ge-0/0/5
type: string
rate:
type: integer
run_length:
minimum: 0
type: integer
type: object
response_device_search:
additionalProperties: false
properties:
end:
type: integer
limit:
type: integer
next:
type: string
results:
$ref: '#/components/schemas/response_device_search_results'
start:
type: integer
total:
type: integer
required:
- end
- limit
- results
- start
- total
type: object
snmp_usm_user:
additionalProperties: false
properties:
authentication_password:
description: Not required if `authentication_type`==`authentication-none`. Include alphabetic, numeric, and special characters, but it cannot include control characters.
minLength: 7
type: string
authentication_type:
$ref: '#/components/schemas/snmp_usm_user_authentication_type'
encryption_password:
description: Not required if `encryption_type`==`privacy-none`. Include alphabetic, numeric, and special characters, but it cannot include control characters
minLength: 8
type: string
encryption_type:
$ref: '#/components/schemas/snmp_usm_user_encryption_type'
name:
type: string
type: object
routing_policy_term_matching_as_path:
items:
$ref: '#/components/schemas/bgp_as'
type: array
tunnel_provider_options:
additionalProperties: false
properties:
jse:
$ref: '#/components/schemas/tunnel_provider_options_jse'
prisma:
$ref: '#/components/schemas/tunnel_provider_options_prisma'
zscaler:
$ref: '#/components/schemas/tunnel_provider_options_zscaler'
type: object
radius_acct_server:
additionalProperties: false
properties:
host:
description: IP/ hostname of RADIUS server
examples:
- 1.2.3.4
type: string
keywrap_enabled:
type: boolean
keywrap_format:
$ref: '#/components/schemas/radius_keywrap_format'
keywrap_kek:
examples:
- '1122334455'
type: string
keywrap_mack:
examples:
- '1122334455'
type: string
port:
$ref: '#/components/schemas/radius_acct_port'
secret:
description: Secret of RADIUS server
examples:
- testing123
format: password
type: string
required:
- host
- secret
type: object
gateway_mgmt_probe_hostsv6:
examples:
- - 2001:4860:4860::8888
format: ipv6
items:
type: string
type: array
network_internet_access_static_nat:
additionalProperties:
$ref: '#/components/schemas/network_internet_access_static_nat_property'
description: Property key may be an External IP Address (i.e. "63.16.0.3"), a CIDR (i.e. "63.16.0.12/20") or a Variable (i.e. "{{myvar}}")
type: object
idp_profile:
properties:
base_profile:
$ref: '#/components/schemas/idp_profile_base_profile'
created_time:
$ref: '#/components/schemas/created_time'
id:
$ref: '#/components/schemas/id'
modified_time:
$ref: '#/components/schemas/modified_time'
name:
examples:
- relaxed
type: string
org_id:
$ref: '#/components/schemas/org_id'
overwrites:
$ref: '#/components/schemas/idp_profile_overwrites'
type: object
response_count:
additionalProperties: false
properties:
distinct:
type: string
end:
type: integer
limit:
type: integer
results:
$ref: '#/components/schemas/count_results'
start:
type: integer
total:
type: integer
required:
- distinct
- end
- limit
- results
- start
- total
type: object
switch_port_local_usage_dot1x:
description: 'if dot1x is desired, set to dot1x. enum: `dot1x`'
enum:
- dot1x
type:
- string
- 'null'
remote_syslog:
additionalProperties: false
properties:
archive:
$ref: '#/components/schemas/remote_syslog_archive'
cacerts:
$ref: '#/components/schemas/remote_syslog_cacerts'
console:
$ref: '#/components/schemas/remote_syslog_console'
enabled:
default: false
type: boolean
files:
$ref: '#/components/schemas/remote_syslog_files'
network:
description: If source_address is configured, will use the vlan firstly otherwise use source_ip
examples:
- default
type: string
send_to_all_servers:
default: false
type: boolean
servers:
$ref: '#/components/schemas/remote_syslog_servers'
time_format:
$ref: '#/components/schemas/remote_syslog_time_format'
users:
$ref: '#/components/schemas/remote_syslog_users'
type: object
gateway_wan_ppoe_auth:
default: none
description: 'if `type`==`pppoe`. enum: `chap`, `none`, `pap`'
enum:
- chap
- none
- pap
type: string
switch_port_usage_dynamic_rule_equals_any:
description: Use `equals_any` to match any item in a list
items:
type: string
type: array
snmp_config_trap_group_targets:
items:
examples:
- 172.29.158.19
type: string
type: array
network_source_nat:
additionalProperties: false
description: If `routed`==`false` (usually at Spoke), but some hosts needs to be reachable from Hub
properties:
external_ip:
examples:
- 172.16.0.8/30
type: string
type: object
network_tenant_addresses:
items:
description: The user/tenant IP Address (i.e. "192.168.70.30"), an Subnet (i.e. "192.168.70.0/24") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.30
type: string
type: array
device_type_switch:
description: 'Device Type. enum: `switch`'
enum:
- switch
type: string
snmpv3_config_target_param:
additionalProperties: false
properties:
message_processing_model:
$ref: '#/components/schemas/snmpv3_config_target_param_mess_process_model'
name:
type: string
notify_filter:
description: Refer to profile-name in notify_filter
type: string
security_level:
$ref: '#/components/schemas/snmpv3_config_target_param_security_level'
security_model:
$ref: '#/components/schemas/snmpv3_config_target_param_security_model'
security_name:
description: Refer to security_name in usm
examples:
- m01620
type: string
type: object
gateway_ip_config_property_second_ips:
description: Optional list of secondary IPs in CIDR format
examples:
- - 192.168.50.1/24
- 192.168.60.1/26
items:
type: string
type: array
app_probing:
additionalProperties: false
properties:
apps:
$ref: '#/components/schemas/app_probing_apps'
custom_apps:
$ref: '#/components/schemas/app_probing_custom_apps'
enabled:
type: boolean
type: object
response_config_history_search_results:
items:
$ref: '#/components/schemas/response_config_history_search_item'
type: array
uniqueItems: true
junos_port_config:
additionalProperties: false
description: Switch port config
properties:
ae_disable_lacp:
description: To disable LACP support for the AE interface
type: boolean
ae_idx:
description: Users could force to use the designated AE name
type: integer
ae_lacp_force_up:
default: false
description: 'If `aggregated`==`true`, sets the state of the interface as UP when the peer has limited LACP capability. Use case: When a device connected to this AE port is ZTPing for the first time, it will not have LACP configured on the other end. **Note:** Turning this on will enable force-up on one of the interfaces in the bundle only'
type: boolean
ae_lacp_slow:
description: To use slow timeout
type: boolean
aggregated:
default: false
type: boolean
critical:
default: false
description: To generate port up/down alarm
type: boolean
description:
type: string
disable_autoneg:
default: false
description: If `speed` and `duplex` are specified, whether to disable autonegotiation
type: boolean
duplex:
$ref: '#/components/schemas/junos_port_config_duplex'
dynamic_usage:
description: Enable dynamic usage for this port. Set to `dynamic` to enable.
type:
- string
- 'null'
esilag:
type: boolean
mtu:
default: 1514
description: Media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation
type: integer
networks:
description: List of network names. Required if `usage`==`inet`
items:
type: string
type: array
no_local_overwrite:
default: true
description: Prevent helpdesk to override the port config
type: boolean
poe_disabled:
default: false
type: boolean
port_network:
description: Required if `usage`==`vlan_tunnel`. Q-in-Q tunneling using All-in-one bundling. This also enables standard L2PT for interfaces that are not encapsulation tunnel interfaces and uses MAC rewrite operation. [View more information](https://www.juniper.net/documentation/us/en/software/junos/multicast-l2/topics/topic-map/q-in-q.html#id-understanding-qinq-tunneling-and-vlan-translation)
type: string
speed:
$ref: '#/components/schemas/junos_port_config_speed'
usage:
description: Port usage name. For Q-in-Q, use `vlan_tunnel`. If EVPN is used, use `evpn_uplink`or `evpn_downlink`
type: string
required:
- usage
type: object
tunnel_config_ike_mode:
default: main
description: 'Only if `provider`==`custom-ipsec`. enum: `aggressive`, `main`'
enum:
- aggressive
- main
type: string
tunnel_config_auto_provision_lat_lng:
additionalProperties: false
description: API override for POP selection
properties:
lat:
examples:
- 37.295833
format: double
type: number
lng:
examples:
- -122.032946
format: double
type: number
required:
- lat
- lng
type: object
sw_routing_policy_term:
additionalProperties: false
properties:
actions:
$ref: '#/components/schemas/sw_routing_policy_term_action'
matching:
$ref: '#/components/schemas/sw_routing_policy_term_matching'
name:
type: string
required:
- name
type: object
ap_radio_band24:
additionalProperties: false
description: Radio Band AP settings
properties:
allow_rrm_disable:
default: false
type: boolean
ant_gain:
default: 0
maximum: 10
minimum: 0
type:
- integer
- 'null'
antenna_mode:
$ref: '#/components/schemas/radio_band_antenna_mode'
bandwidth:
$ref: '#/components/schemas/dot11_bandwidth24'
channel:
default: null
description: For Device. (primary) channel for the band, 0 means using the Site Setting
examples:
- 6
maximum: 13
minimum: 1
type:
- integer
- 'null'
channels:
$ref: '#/components/schemas/radio_band_channels'
disabled:
default: false
description: Whether to disable the radio
type: boolean
power:
default: null
description: 'TX power of the radio. For Devices, 0 means auto. -1 / -2 / -3 / …: treated as 0 / -1 / -2 / …'
examples:
- 3
maximum: 25
minimum: 3
type:
- integer
- 'null'
power_max:
default: 17
description: When power=0, max tx power to use, HW-specific values will be used if not set
maximum: 18
minimum: 3
type:
- integer
- 'null'
power_min:
default: 8
description: When power=0, min tx power to use, HW-specific values will be used if not set
maximum: 18
minimum: 3
type:
- integer
- 'null'
preamble:
$ref: '#/components/schemas/radio_band_preamble'
type: object
dhcpd_config_type6:
default: none
description: 'enum: `local` (DHCP Server), `none`, `relay` (DHCP Relay)'
enum:
- local
- none
- relay
type: string
snmpv3_config:
additionalProperties: false
properties:
notify:
$ref: '#/components/schemas/snmpv3_config_notify'
notify_filter:
$ref: '#/components/schemas/snmpv3_config_notify_filter'
target_address:
$ref: '#/components/schemas/snmpv3_config_target_address'
target_parameters:
$ref: '#/components/schemas/snmpv3_config_target_params'
usm:
$ref: '#/components/schemas/snmp_usms'
vacm:
$ref: '#/components/schemas/snmp_vacm'
type: object
radius_config:
additionalProperties: false
description: Junos Radius config
properties:
acct_interim_interval:
default: 0
description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
maximum: 65535
minimum: 0
type: integer
acct_servers:
$ref: '#/components/schemas/radius_acct_servers'
auth_servers:
$ref: '#/components/schemas/radius_auth_servers'
auth_servers_retries:
default: 3
description: radius auth session retries
type: integer
auth_servers_timeout:
default: 5
description: radius auth session timeout
type: integer
coa_enabled:
default: false
type: boolean
coa_port:
default: 3799
maximum: 65535
minimum: 1
type: integer
network:
description: use `network`or `source_ip`, which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
type: string
source_ip:
description: use `network`or `source_ip`
type: string
type: object
response_device_search_results_items:
oneOf:
- $ref: '#/components/schemas/ap_search'
- $ref: '#/components/schemas/switch_search'
- $ref: '#/components/schemas/gateway_search'
switch_port_mirroring_ingress_port_ids:
description: At least one of the `input_port_ids_ingress`, `input_port_ids_egress` or `input_networks_ingress ` should be specified
items:
examples:
- ge-0/0/3
type: string
type: array
gateway_extra_routes6:
additionalProperties:
$ref: '#/components/schemas/gateway_extra_route6'
description: Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64"), the destination Network name or a variable (e.g. "{{myvar}}")
examples:
- 2a02:1234:420a:10c9::/64:
via: 2a02:1234:200a::100
type: object
ap_led:
additionalProperties: false
description: LED AP settings
properties:
brightness:
default: 255
examples:
- 255
maximum: 255
minimum: 0
type: integer
enabled:
default: true
type: boolean
type: object
dhcpd_config_dns_servers:
description: If `type`==`local` or `type6`==`local` - optional, if not defined, system one will be used
examples:
- - 8.8.8.8
- 4.4.4.4
- 2001:4860:4860::8888
items:
type: string
type: array
remote_syslog_cacerts:
examples:
- - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----'
- '-----BEGIN CERTIFICATE-----\nBhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----'
items:
type: string
type: array
gateway_port_vpn_path_role:
default: spoke
description: 'If the VPN `type`==`hub_spoke`, enum: `hub`, `spoke`. If the VPN `type`==`mesh`, enum: `mesh`'
enum:
- hub
- mesh
- spoke
type: string
site_devices_count_distinct:
default: model
description: 'enum: `hostname`, `lldp_mgmt_addr`, `lldp_port_id`, `lldp_system_desc`, `lldp_system_name`, `map_id`, `model`, `mxedge_id`, `mxtunnel_status`, `version`'
enum:
- hostname
- lldp_mgmt_addr
- lldp_port_id
- lldp_system_desc
- lldp_system_name
- map_id
- model
- mxedge_id
- mxtunnel_status
- version
type: string
ospf_area_network_auth_type:
default: none
description: 'auth type. enum: `md5`, `none`, `password`'
enum:
- md5
- none
- password
examples:
- md5
type: string
gateway_extra_route:
additionalProperties: false
properties:
via:
format: ipv4
type: string
type: object
dot11_bandwidth5:
default: 40
description: 'channel width for the 5GHz band. enum: `0`(disabled, response only), `20`, `40`, `80`'
enum:
- 0
- 20
- 40
- 80
examples:
- 40
type: integer
snmp_vacm_security_to_group:
additionalProperties: false
properties:
content:
$ref: '#/components/schemas/snmp_vacm_security_to_group_content'
security_model:
$ref: '#/components/schemas/snmp_vacm_security_model'
type: object
tunnel_provider_options_jse:
additionalProperties: false
description: For jse-ipsec, this allows provisioning of adequate resource on JSE. Make sure adequate licenses are added
properties:
num_users:
examples:
- 5
type: integer
org_name:
description: JSE Organization name. The list of available organizations can be retrieved with the [Get Org JSE Info](/#operations/getOrgJseInfo) API Call
examples:
- JSE_ORG1
type: string
type: object
network_vpn_access_destination_nat_property:
additionalProperties: false
properties:
internal_ip:
description: The Destination NAT destination IP Address. Must be an IP (i.e. "192.168.70.30") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.30
type: string
name:
examples:
- web server
type: string
port:
examples:
- '443'
type: string
type: object
response_config_history_search:
additionalProperties: false
properties:
end:
type: integer
limit:
type: integer
next:
type: string
results:
$ref: '#/components/schemas/response_config_history_search_results'
start:
type: integer
total:
type: integer
required:
- end
- limit
- results
- start
- total
type: object
image_import:
additionalProperties: false
properties:
file:
contentMediaType: application/octet-stream
description: Binary file
type: string
json:
type: string
required:
- file
type: object
tacacs_acct_servers:
items:
$ref: '#/components/schemas/tacacs_acct_server'
type: array
switch_bgp_config_hold_time_zero:
enum:
- 0
type: integer
protect_re_allowed_services:
description: Optionally, services we'll allow
examples:
- - icmp
- ssh
items:
$ref: '#/components/schemas/protect_re_allowed_service'
type: array
dhcpd_config_servers6:
description: If `type6`==`relay`
examples:
- - 2607:f8b0:4005:808::64
items:
type: string
type: array
switch_dhcpd_config_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_option'
description: If `type`==`server` or `type6`==`server`. Property key is the DHCP option number
type: object
ap_ip_config_dns:
description: If `type`==`static`
examples:
- - 8.8.8.8
- 4.4.4.4
items:
type: string
type: array
switch_port_local_usage_storm_control:
additionalProperties: false
description: Switch storm control
properties:
disable_port:
default: false
description: Whether to disable the port when storm control is triggered
type: boolean
no_broadcast:
default: false
description: Whether to disable storm control on broadcast traffic
type: boolean
no_multicast:
default: false
description: Whether to disable storm control on multicast traffic
type: boolean
no_registered_multicast:
default: false
description: Whether to disable storm control on registered multicast traffic
type: boolean
no_unknown_unicast:
default: false
description: Whether to disable storm control on unknown unicast traffic
type: boolean
percentage:
default: 80
description: Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth
maximum: 100
minimum: 0
type: integer
type: object
snmp_vacm_access_item_prefix_list_item:
additionalProperties: false
properties:
context_prefix:
description: Only required if `type`==`context_prefix`
examples:
- iil
type: string
notify_view:
description: Refer to view name
examples:
- all
type: string
read_view:
description: Refer to view name
examples:
- all
type: string
security_level:
$ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item_level'
security_model:
$ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item_model'
type:
$ref: '#/components/schemas/snmp_vacm_access_item_type'
write_view:
description: Refer to view name
examples:
- all
type: string
type: object
switch_port_usage_dynamic_vlan_networks:
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`, if dynamic vlan is used, specify the possible networks/vlans RADIUS can return
examples:
- - corp
- user
items:
type: string
type: array
ap_ip_config_dns_suffix:
description: Required if `type`==`static`
examples:
- - .mist.local
- .mist.com
items:
type: string
type: array
junos_local_port_config:
additionalProperties: false
description: Switch port config
properties:
all_networks:
default: false
description: Only if `mode`==`trunk` whether to trunk all network/vlans
type: boolean
allow_dhcpd:
description: 'Controls whether DHCP server traffic is allowed on ports using this configuration if DHCP snooping is enabled. This is a tri-state setting; `true`: ports become trusted ports allowing DHCP server traffic, `false`: ports become untrusted blocking DHCP server traffic, undefined: use system defaults (access ports default to untrusted, trunk ports default to trusted).'
type: boolean
allow_multiple_supplicants:
default: false
type: boolean
bypass_auth_when_server_down:
default: false
description: Only if `port_auth`==`dot1x` bypass auth for known clients if set to true when RADIUS server is down
type: boolean
bypass_auth_when_server_down_for_unknown_client:
default: false
description: Only if `port_auth`=`dot1x` bypass auth for all (including unknown clients) if set to true when RADIUS server is down
type: boolean
description:
type: string
disable_autoneg:
default: false
description: Only if `mode`!=`dynamic` if speed and duplex are specified, whether to disable autonegotiation
type: boolean
disabled:
default: false
description: Whether the port is disabled
type: boolean
duplex:
$ref: '#/components/schemas/switch_port_local_usage_duplex'
dynamic_vlan_networks:
$ref: '#/components/schemas/switch_port_local_usage_dynamic_vlan_networks'
enable_mac_auth:
default: false
description: Only if `port_auth`==`dot1x` whether to enable MAC Auth
type: boolean
enable_qos:
default: false
type: boolean
guest_network:
description: Only if `port_auth`==`dot1x` which network to put the device into if the device cannot do dot1x. default is null (i.e. not allowed)
type:
- string
- 'null'
inter_switch_link:
default: false
description: 'inter_switch_link is used together with "isolation" under networks. NOTE: inter_switch_link works only between Juniper devices. This has to be applied to both ports connected together'
type: boolean
mac_auth_only:
description: Only if `enable_mac_auth`==`true`
type: boolean
mac_auth_preferred:
description: Only if `enable_mac_auth`==`true` + `mac_auth_only`==`false`, dot1x will be given priority then mac_auth. Enable this to prefer mac_auth over dot1x.
type: boolean
mac_auth_protocol:
$ref: '#/components/schemas/switch_port_local_usage_mac_auth_protocol'
mac_limit:
default: 0
description: Max number of mac addresses, default is 0 for unlimited, otherwise range is 1 or higher, with upper bound constrained by platform
minimum: 0
type: integer
mode:
$ref: '#/components/schemas/switch_port_local_usage_mode'
mtu:
description: Media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514.
type: integer
networks:
$ref: '#/components/schemas/switch_port_usage_networks'
note:
description: Additional note for the port config override
examples:
- force 100M for camera
type: string
persist_mac:
default: false
description: Only if `mode`==`access` and `port_auth`!=`dot1x` whether the port should retain dynamically learned MAC addresses
type: boolean
poe_disabled:
default: false
description: Whether PoE capabilities are disabled for a port
type: boolean
port_auth:
$ref: '#/components/schemas/switch_port_local_usage_dot1x'
port_network:
description: Native network/vlan for untagged traffic
type: string
reauth_interval:
$ref: '#/components/schemas/switch_port_usage_reauth_interval'
server_fail_network:
description: Only if `port_auth`==`dot1x` sets server fail fallback vlan
type:
- string
- 'null'
server_reject_network:
description: Only if `port_auth`==`dot1x` when radius server reject / fails
type:
- string
- 'null'
speed:
$ref: '#/components/schemas/junos_port_config_speed'
storm_control:
$ref: '#/components/schemas/switch_port_local_usage_storm_control'
stp_edge:
default: false
description: When enabled, the port is not expected to receive BPDU frames
type: boolean
stp_no_root_port:
default: false
type: boolean
stp_p2p:
default: false
type: boolean
usage:
description: Port usage name.
type: string
use_vstp:
default: false
description: If this is connected to a vstp network
type: boolean
voip_network:
description: Network/vlan for voip traffic, must also set port_network. to authenticate device, set port_auth
type: string
required:
- usage
type: object
device_events:
items:
$ref: '#/components/schemas/device_event'
type: array
uniqueItems: true
next_hop_via:
description: Next-hop IP Address. Can be a single IP address or an array of IP addresses for ECMP (Equal-Cost Multi-Path) load balancing across multiple next-hops.
examples:
- 10.2.1.1
- - 10.2.1.1
- 10.2.1.2
oneOf:
- type: string
- items:
type: string
type: array
antenna_select:
description: 'Antenna Mode for AP which supports selectable antennas. enum: `""` (default), `external`, `internal`'
enum:
- ''
- external
- internal
examples:
- external
type: string
protect_re_custom:
additionalProperties: false
description: Custom acls
properties:
port_range:
default: '0'
description: Matched dst port, "0" means any
examples:
- 80,1035-1040
type: string
protocol:
$ref: '#/components/schemas/protect_re_custom_protocol'
subnets:
$ref: '#/components/schemas/protect_re_custom_subnet'
type: object
gateway_port_mirroring:
additionalProperties: false
properties:
port_mirror:
$ref: '#/components/schemas/gateway_port_mirroring_port_mirror'
type: object
gateway_port_vpn_path_bfd_profile:
default: broadband
description: 'Only if the VPN `type`==`hub_spoke`. enum: `broadband`, `lte`'
enum:
- broadband
- lte
type: string
radio_band_preamble:
default: short
description: 'enum: `auto`, `long`, `short`'
enum:
- auto
- long
- short
type: string
config_switch_local_accounts:
additionalProperties:
$ref: '#/components/schemas/config_switch_local_accounts_user'
description: Property key is the user name. For Local user authentication
type: object
snmpv3_config_notify_filter_item_content:
additionalProperties: false
properties:
include:
type: boolean
oid:
examples:
- 1.3.6.1.4.1
type: string
type: object
ap_mesh_role:
description: 'enum: `base`, `remote`'
enum:
- base
- remote
examples:
- base
type: string
ap_zigbee_allow_join:
default: manual
description: 'Controls whether new Zigbee devices are allowed to join the network. enum: `always`, `manual`'
enum:
- always
- manual
examples:
- manual
type: string
tunnel_config_ike_proposal:
additionalProperties: false
properties:
auth_algo:
$ref: '#/components/schemas/tunnel_config_auth_algo'
dh_group:
$ref: '#/components/schemas/tunnel_config_ike_dh_group'
enc_algo:
$ref: '#/components/schemas/tunnel_config_enc_algo'
type: object
sw_routing_policy_term_matching_protocol_enum:
description: 'enum: `bgp`, `direct`, `evpn`, `ospf`, `static`'
enum:
- bgp
- direct
- evpn
- ospf
- static
type: string
gateway_ip_config_dns_servers:
description: Except for out-of_band interface (vme/em0/fxp0)
items:
type: string
type: array
snmp_config_trap_group_categories:
items:
examples:
- authentication
type: string
type: array
remote_syslog_contents:
items:
$ref: '#/components/schemas/remote_syslog_content'
type: array
ap_pwr_config:
additionalProperties: false
description: Power related configs
properties:
base:
default: 0
description: Additional power to request during negotiating with PSE over PoE, in mW
examples:
- 2000
type: integer
prefer_usb_over_wifi:
default: false
description: Whether to enable power out to peripheral, meanwhile will reduce power to Wi-Fi (only for AP45 at power mode)
type: boolean
type: object
devices_gbp_tag:
properties:
gbp_tag:
type: integer
macs:
$ref: '#/components/schemas/mac_addresses_macs'
required:
- macs
- gbp_tag
type: object
protect_re:
additionalProperties: false
description: "Restrict inbound-traffic to host\nwhen enabled, all traffic that is not essential to our operation will be dropped \ne.g. ntp / dns / traffic to mist will be allowed by default, if dhcpd is enabled, we'll make sure it works"
properties:
allowed_services:
$ref: '#/components/schemas/protect_re_allowed_services'
custom:
$ref: '#/components/schemas/protect_re_customs'
enabled:
default: false
description: "When enabled, all traffic that is not essential to our operation will be dropped\ne.g. ntp / dns / traffic to mist will be allowed by default\n if dhcpd is enabled, we'll make sure it works"
type: boolean
hit_count:
default: false
description: Whether to enable hit count for Protect_RE policy
type: boolean
trusted_hosts:
$ref: '#/components/schemas/protect_re_trusted_hosts'
type: object
switch_dhcpd_config_dns_suffix:
description: If `type`==`server` or `type6`==`server` - optional, if not defined, system one will be used
examples:
- - .mist.local
- .mist.com
items:
type: string
type: array
tunnel_config_probe:
additionalProperties: false
description: Only if `provider`==`custom-ipsec`
properties:
interval:
description: How often to trigger the probe
type: integer
threshold:
description: Number of consecutive misses before declaring the tunnel down
type: integer
timeout:
description: Time within which to complete the connectivity check
type: integer
type:
$ref: '#/components/schemas/tunnel_config_probe_type'
type: object
remote_syslog_user:
additionalProperties: false
properties:
contents:
$ref: '#/components/schemas/remote_syslog_contents'
match:
examples:
- '"!alarm|ntp|errors.crc_error[chan]"'
type: string
user:
examples:
- '*'
type: string
type: object
device_ap_lacp_config:
additionalProperties: false
properties:
enabled:
default: false
type: boolean
type: object
vrrp_config_group:
additionalProperties: false
properties:
preempt:
default: false
description: If `true`, allow preemption (a backup router can preempt a primary router)
type: boolean
priority:
type: integer
type: object
snmp_config_v2c_config:
additionalProperties: false
properties:
authorization:
examples:
- read-only
type: string
client_list_name:
description: Client_list_name here should refer to client_list above
examples:
- clist-1
type: string
community_name:
examples:
- abc123
type: string
view:
description: View name here should be defined in views above
examples:
- all
type: string
type: object
protect_re_trusted_hosts:
description: host/subnets we'll allow traffic to/from
items:
examples:
- 10.242.3.0/24
type: string
type: array
switch_bgp_config_type:
description: 'enum: `external`, `internal`'
enum:
- external
- internal
type: string
sw_routing_policy_term_action:
additionalProperties: false
description: When used as import policy
properties:
accept:
type: boolean
community:
$ref: '#/components/schemas/routing_policy_term_action_community'
local_preference:
$ref: '#/components/schemas/routing_policy_local_preference'
prepend_as_path:
$ref: '#/components/schemas/routing_policy_term_action_prepend_as_path'
type: object
snmp_config_engine_id_type:
default: local
description: 'enum: `local`, `use_mac_address`'
enum:
- local
- use_mac_address
type: string
switch_ospf_config_area:
properties:
no_summary:
default: false
description: Disable OSPF summary routes for this area
type: boolean
gateway_port_networks:
description: If `usage`==`lan`, name of the [networks]($h/Orgs%20Networks/_overview) to attach to the interface
items:
type: string
type: array
remote_syslog_file_config:
additionalProperties: false
properties:
archive:
$ref: '#/components/schemas/remote_syslog_archive'
contents:
$ref: '#/components/schemas/remote_syslog_contents'
enable_tls:
description: Only if `protocol`==`tcp`
type: boolean
explicit_priority:
type: boolean
file:
examples:
- file-name
type: string
match:
examples:
- '!alarm|ntp|errors.crc_error[chan]'
type: string
structured_data:
type: boolean
type: object
ap_uplink_port_config:
additionalProperties: false
description: AP Uplink port configuration
properties:
dot1x:
default: false
description: Whether to do 802.1x against uplink switch. When enabled, AP cert will be used to do EAP-TLS and the Org's CA Cert has to be provisioned at the switch
type: boolean
keep_wlans_up_if_down:
default: false
description: By default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
type: boolean
type: object
ip_type:
default: dhcp
description: 'enum: `dhcp`, `static`'
enum:
- dhcp
- static
examples:
- static
type: string
dhcp_snooping_networks:
description: If `all_networks`==`false`, list of network with DHCP snooping enabled
items:
type: string
type: array
network_multicast_groups:
additionalProperties:
$ref: '#/components/schemas/network_multicast_group'
description: Group address to RP (rendezvous point) mapping. Property Key is the CIDR (example "225.1.0.3/32")
type: object
vars:
additionalProperties:
type: string
description: Dictionary of name->value, the vars can then be used in Wlans. This can overwrite those from Site Vars
examples:
- RADIUS_IP1: 172.31.2.5
RADIUS_SECRET: 11s64632d
type: object
gateway_port_wan_type:
default: broadband
description: 'Only if `usage`==`wan`. enum: `broadband`, `dsl`, `lte`'
enum:
- broadband
- dsl
- lte
type: string
site_id:
examples:
- 441a1214-6928-442a-8e92-e1d34b8ec6a6
format: uuid
readOnly: true
type: string
ap_radio_band6:
additionalProperties: false
description: Radio Band AP settings
properties:
allow_rrm_disable:
default: false
type: boolean
ant_gain:
default: 0
maximum: 10
minimum: 0
type:
- integer
- 'null'
antenna_beam_pattern:
$ref: '#/components/schemas/radio_band_antenna_beam_pattern'
antenna_mode:
$ref: '#/components/schemas/radio_band_antenna_mode'
bandwidth:
$ref: '#/components/schemas/dot11_bandwidth6'
channel:
default: null
description: For Device. (primary) channel for the band, 0 means using the Site Setting
examples:
- 0
type:
- integer
- 'null'
channels:
$ref: '#/components/schemas/radio_band_channels'
disabled:
default: false
description: Whether to disable the radio
type: boolean
power:
default: null
description: 'TX power of the radio. For Devices, 0 means auto. -1 / -2 / -3 / …: treated as 0 / -1 / -2 / …'
examples:
- 7
maximum: 25
minimum: 5
type:
- integer
- 'null'
power_max:
default: 18
description: When power=0, max tx power to use, HW-specific values will be used if not set
maximum: 18
minimum: 5
type:
- integer
- 'null'
power_min:
default: 8
description: When power=0, min tx power to use, HW-specific values will be used if not set
maximum: 18
minimum: 5
type:
- integer
- 'null'
preamble:
$ref: '#/components/schemas/radio_band_preamble'
standard_power:
default: false
description: For 6GHz Only, standard-power operation, AFC (Automatic Frequency Coordination) will be performed, and we'll fall back to Low Power Indoor if AFC failed
type: boolean
type: object
dhcpd_config_fixed_binding:
additionalProperties: false
properties:
ip:
examples:
- 192.168.70.35
type: string
ip6:
examples:
- 2607:f8b0:4005:808::2
type: string
name:
type: string
type: object
dhcpd_config_option:
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/dhcpd_config_option_type'
value:
type: string
type: object
switch_networks:
additionalProperties:
$ref: '#/components/schemas/switch_network'
description: Property key is network name
type: object
ospf_area_network_interface_type:
default: broadcast
description: 'interface type (nbma = non-broadcast multi-access). enum: `broadcast`, `nbma`, `p2mp`, `p2p`'
enum:
- broadcast
- nbma
- p2mp
- p2p
type: string
ble_config_beam_disabled:
description: List of AP BLE location beam numbers (1-8) which should be disabled at the AP and not transmit location information (where beam 1 is oriented at the top the AP, growing counter-clock-wise, with 9 being the omni BLE beam)
examples:
- - 1
- 3
- 6
items:
type: integer
type: array
idp_profile_matching:
additionalProperties: false
properties:
attack_name:
$ref: '#/components/schemas/idp_profile_matching_attack_name'
dst_subnet:
$ref: '#/components/schemas/idp_profile_matching_dst_subnet'
severity:
$ref: '#/components/schemas/idp_profile_matching_severity'
type: object
switch_port_mirroring:
additionalProperties:
$ref: '#/components/schemas/switch_port_mirroring_property'
description: Property key is the port mirroring instance name. `port_mirroring` can be added under device/site settings. It takes interface and ports as input for ingress, interface as input for egress and can take interface and port as output. A maximum 4 mirroring ports is allowed
type: object
snmp_vacm_access:
items:
$ref: '#/components/schemas/snmp_vacm_access_item'
type: array
network_vpn_access_static_nat:
additionalProperties:
$ref: '#/components/schemas/network_vpn_access_static_nat_property'
description: Property key may be an External IP Address (i.e. "63.16.0.3"), a CIDR (i.e. "63.16.0.12/20") or a Variable (i.e. "{{myvar}}")
type: object
radius_acct_servers:
items:
$ref: '#/components/schemas/radius_acct_server'
type: array
uniqueItems: true
gw_routing_policy_term_action_exclude_community:
items:
examples:
- '3900190'
type: string
type: array
config_switch_local_accounts_user_role:
default: none
description: 'enum: `admin`, `helpdesk`, `none`, `read`'
enum:
- admin
- helpdesk
- none
- read
type: string
switch_port_local_usage_duplex:
default: auto
description: 'link connection mode. enum: `auto`, `full`, `half`'
enum:
- auto
- full
- half
type: string
local_port_config:
additionalProperties:
$ref: '#/components/schemas/junos_local_port_config'
description: Local port override, overriding the port configuration from `port_config`. Property key is the port name or range (e.g. "ge-0/0/0-10")
type: object
switch_port_usage_dot1x:
description: 'Only if `mode`!=`dynamic`. If dot1x is desired, set to dot1x. enum: `dot1x`'
enum:
- dot1x
type:
- string
- 'null'
snmpv3_config_notify_filter:
items:
$ref: '#/components/schemas/snmpv3_config_notify_filter_item'
type: array
remote_syslog_facility:
default: any
description: 'enum: `any`, `authorization`, `change-log`, `config`, `conflict-log`, `daemon`, `dfc`, `external`, `firewall`, `ftp`, `interactive-commands`, `kernel`, `ntp`, `pfe`, `security`, `user`'
enum:
- any
- authorization
- change-log
- config
- conflict-log
- daemon
- dfc
- external
- firewall
- ftp
- interactive-commands
- kernel
- ntp
- pfe
- security
- user
examples:
- config
type: string
remote_syslog_server_port:
anyOf:
- default: 514
maximum: 65545
minimum: 1
type: integer
- type: string
description: Syslog Service Port, value from 1 to 65535
response_config_history_search_item_wlan:
additionalProperties: false
properties:
auth:
type: string
bands:
$ref: '#/components/schemas/strings'
id:
$ref: '#/components/schemas/id'
ssid:
type: string
vlan_ids:
$ref: '#/components/schemas/strings'
required:
- auth
- id
- ssid
type: object
switch_vrf_instance:
additionalProperties: false
examples:
- extra_routes:
0.0.0.0/0:
via: 192.168.31.1
networks:
- guest
properties:
aggregate_routes:
$ref: '#/components/schemas/aggregate_routes'
aggregate_routes6:
$ref: '#/components/schemas/aggregate_routes6'
evpn_auto_loopback_subnet:
examples:
- 100.101.0.0/24
type: string
evpn_auto_loopback_subnet6:
type: string
extra_routes:
$ref: '#/components/schemas/vrf_extra_routes'
extra_routes6:
$ref: '#/components/schemas/vrf_extra_routes6'
networks:
$ref: '#/components/schemas/strings'
type: object
response_device_search_results:
items:
$ref: '#/components/schemas/response_device_search_results_items'
type: array
uniqueItems: true
switch_port_usage_mac_limit_overwrite:
anyOf:
- default: 0
maximum: 16383
minimum: 0
type: integer
- type: string
description: Max number of mac addresses, default is 0 for unlimited, otherwise range is 1 to 16383 (upper bound constrained by platform)
response_config_history_search_item_wlans:
items:
$ref: '#/components/schemas/response_config_history_search_item_wlan'
type: array
uniqueItems: true
day_of_week:
description: 'enum: `any`, `fri`, `mon`, `sat`, `sun`, `thu`, `tue`, `wed`'
enum:
- any
- fri
- mon
- sat
- sun
- thu
- tue
- wed
type: string
remote_syslog_server:
additionalProperties: false
properties:
contents:
$ref: '#/components/schemas/remote_syslog_contents'
explicit_priority:
type: boolean
facility:
$ref: '#/components/schemas/remote_syslog_facility'
host:
examples:
- syslogd.internal
type: string
match:
examples:
- '!alarm|ntp|errors.crc_error[chan]'
type: string
port:
$ref: '#/components/schemas/remote_syslog_server_port'
protocol:
$ref: '#/components/schemas/remote_syslog_server_protocol'
routing_instance:
examples:
- routing-instance-name
type: string
server_name:
description: Name of the server
examples:
- syslogd.internal
type: string
severity:
$ref: '#/components/schemas/remote_syslog_severity'
source_address:
description: If source_address is configured, will use the vlan firstly otherwise use source_ip
type: string
structured_data:
type: boolean
tag:
type: string
type: object
service_policy_skyatp_dns_dga_detection_profile:
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
gateway_port_config:
additionalProperties: false
description: Gateway port config
properties:
ae_disable_lacp:
default: false
description: If `aggregated`==`true`. To disable LCP support for the AE interface
type: boolean
ae_idx:
description: If `aggregated`==`true`. Users could force to use the designated AE name (must be an integer between 0 and 127)
type:
- string
- 'null'
ae_lacp_force_up:
default: false
description: 'For SRX only, if `aggregated`==`true`.Sets the state of the interface as UP when the peer has limited LACP capability. Use case: When a device connected to this AE port is ZTPing for the first time, it will not have LACP configured on the other end. **Note:** Turning this on will enable force-up on one of the interfaces in the bundle only'
type: boolean
aggregated:
default: false
type: boolean
critical:
default: false
description: To generate port up/down alarm, set it to true
type: boolean
description:
description: Interface Description. Can be a variable (i.e. "{{myvar}}")
type: string
disable_autoneg:
default: false
type: boolean
disabled:
default: false
description: Port admin up (true) / down (false)
type: boolean
dsl_type:
$ref: '#/components/schemas/gateway_port_dsl_type'
dsl_vci:
default: 35
description: If `wan_type`==`dsl`, 16 bit int
type: integer
dsl_vpi:
default: 0
description: If `wan_type`==`dsl`, 8 bit int
type: integer
duplex:
$ref: '#/components/schemas/gateway_port_duplex'
ip_config:
$ref: '#/components/schemas/gateway_port_config_ip_config'
lte_apn:
description: If `wan_type`==`lte`
type: string
lte_auth:
$ref: '#/components/schemas/gateway_port_lte_auth'
lte_backup:
type: boolean
lte_password:
description: If `wan_type`==`lte`
type: string
lte_username:
description: If `wan_type`==`lte`
type: string
mtu:
type: integer
name:
description: Name that we'll use to derive config
type: string
networks:
$ref: '#/components/schemas/gateway_port_networks'
outer_vlan_id:
description: For Q-in-Q
type: integer
poe_disabled:
default: false
type: boolean
poe_keep_state_when_reboot:
default: false
description: Whether Perpetual PoE capabilities are enabled for a port
type: boolean
port_network:
description: Only for SRX and if `usage`==`lan`, the name of the Network to be used as the Untagged VLAN
type: string
preserve_dscp:
default: true
description: Whether to preserve dscp when sending traffic over VPN (SSR-only)
type: boolean
redundant:
description: If HA mode
type: boolean
redundant_group:
description: If HA mode, SRX Only - support redundancy-group. 1-128 for physical SRX, 1-64 for virtual SRX
maximum: 128
minimum: 1
type: integer
reth_idx:
$ref: '#/components/schemas/gateway_port_config_reth_idx'
reth_node:
description: If HA mode
type: string
reth_nodes:
$ref: '#/components/schemas/gateway_port_reth_nodes'
speed:
default: auto
examples:
- 1g
type: string
ssr_no_virtual_mac:
default: false
description: When SSR is running as VM, this is required on certain hosting platforms
type: boolean
svr_port_range:
default: none
description: For SSR only
examples:
- 60000-60005
type: string
traffic_shaping:
$ref: '#/components/schemas/gateway_traffic_shaping'
usage:
$ref: '#/components/schemas/gateway_port_usage'
vlan_id:
$ref: '#/components/schemas/gateway_port_vlan_id_with_variable'
vpn_paths:
$ref: '#/components/schemas/gateway_port_vpn_paths'
wan_arp_policer:
$ref: '#/components/schemas/gateway_port_wan_arp_policer'
wan_ext_ip:
description: Only if `usage`==`wan`, optional. If spoke should reach this port by a different IP
examples:
- 64.2.4.3
type: string
wan_ext_ip6:
description: Only if `usage`==`wan`, optional. If spoke should reach this port by a different IPv6
examples:
- 2601:1700:43c0:dc0::10
type: string
wan_extra_routes:
additionalProperties:
$ref: '#/components/schemas/wan_extra_routes'
description: Only if `usage`==`wan`. Property Key is the destination CIDR (e.g. "100.100.100.0/24")
type: object
wan_extra_routes6:
additionalProperties:
$ref: '#/components/schemas/wan_extra_routes6'
description: Only if `usage`==`wan`. Property Key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
type: object
wan_networks:
$ref: '#/components/schemas/gateway_port_config_wan_networks'
wan_probe_override:
$ref: '#/components/schemas/gateway_wan_probe_override'
wan_source_nat:
$ref: '#/components/schemas/gateway_port_wan_source_nat'
wan_speedtest_mode:
$ref: '#/components/schemas/gateway_port_config_wan_speedtest_mode'
wan_type:
$ref: '#/components/schemas/gateway_port_wan_type'
required:
- usage
type: object
service_policy:
additionalProperties: false
properties:
action:
$ref: '#/components/schemas/allow_deny'
antivirus:
$ref: '#/components/schemas/service_policy_antivirus'
appqoe:
$ref: '#/components/schemas/service_policy_appqoe'
ewf:
$ref: '#/components/schemas/service_policy_ewf'
idp:
$ref: '#/components/schemas/idp_config'
local_routing:
description: access within the same VRF
type: boolean
name:
type: string
path_preference:
description: By default, we derive all paths available and use them. Optionally, you can customize by using `path_preference`
type: string
secintel:
$ref: '#/components/schemas/service_policy_secintel'
servicepolicy_id:
description: Used to link servicepolicy defined at org level and overwrite some attributes
format: uuid
type: string
services:
$ref: '#/components/schemas/strings'
skyatp:
$ref: '#/components/schemas/service_policy_skyatp'
ssl_proxy:
$ref: '#/components/schemas/service_policy_ssl_proxy'
syslog:
$ref: '#/components/schemas/service_policy_syslog'
tenants:
$ref: '#/components/schemas/strings'
type: object
snmpv3_config_notify_type:
description: 'enum: `inform`, `trap`'
enum:
- inform
- trap
type: string
gateway_wan_probe_override_probe_profile:
default: broadband
description: 'enum: `broadband`, `lte`'
enum:
- broadband
- lte
type: string
tunnel_config_local_subnets:
description: List of Local protected subnet for policy-based IPSec negotiation
items:
type: string
type: array
gateway_port_usage:
description: 'port usage name. enum: `ha_control`, `ha_data`, `lan`, `wan`'
enum:
- ha_control
- ha_data
- lan
- wan
type: string
tacacs_acct_server:
additionalProperties: false
properties:
host:
type: string
port:
type: string
secret:
format: password
type: string
timeout:
default: 10
type: integer
type: object
dhcpd_config_type:
default: local
description: 'enum: `local` (DHCP Server), `none`, `relay` (DHCP Relay)'
enum:
- local
- none
- relay
type: string
gw_routing_policy_term_action:
additionalProperties: false
description: When used as import policy
properties:
accept:
type: boolean
add_community:
$ref: '#/components/schemas/gw_routing_policy_term_action_add_community'
add_target_vrfs:
$ref: '#/components/schemas/gw_routing_policy_term_action_add_target_vrfs'
community:
$ref: '#/components/schemas/routing_policy_term_action_community'
exclude_as_path:
$ref: '#/components/schemas/gw_routing_policy_term_action_exclude_as_path'
exclude_community:
$ref: '#/components/schemas/gw_routing_policy_term_action_exclude_community'
export_communities:
$ref: '#/components/schemas/gw_routing_policy_term_action_export_communities'
local_preference:
$ref: '#/components/schemas/routing_policy_local_preference'
prepend_as_path:
$ref: '#/components/schemas/routing_policy_term_action_prepend_as_path'
type: object
protect_re_custom_subnet:
items:
examples:
- 10.1.2.0/24
type: string
type: array
switch_port_usage_networks:
description: Only if `mode`==`trunk`, the list of network/vlans
items:
type: string
type: array
switch_iot_port_input_src:
default: IN0
description: 'Only for "OUT" ports, input source for the switch iot port out. enum: `IN0`, `IN1`'
enum:
- IN0
- IN1
type: string
ap_airista:
additionalProperties: false
properties:
enabled:
default: false
description: Whether to enable Airista config
type: boolean
host:
default: ''
description: Required if enabled, Airista server host
examples:
- airista.pvt.net
type:
- string
- 'null'
port:
default: 1144
type:
- integer
- 'null'
type: object
switch_port_mirroring_egress_port_ids:
description: At least one of the `input_port_ids_ingress`, `input_port_ids_egress` or `input_networks_ingress ` should be specified
items:
examples:
- ge-0/0/3
type: string
type: array
gateway_ip_configs:
additionalProperties:
$ref: '#/components/schemas/gateway_ip_config_property'
description: Property key is the network name
type: object
gateway_path_type:
description: 'enum: `local`, `tunnel`, `vpn`, `wan`'
enum:
- local
- tunnel
- vpn
- wan
type: string
tunnel_config_remote_subnets:
description: List of Remote protected subnet for policy-based IPSec negotiation
items:
type: string
type: array
search_site_devices_desc_sort:
description: 'enum: `mac`, `model`, `sku`, `timestamp`'
enum:
- mac
- model
- sku
- timestamp
type: string
snmp_vacm_security_to_group_content_item:
additionalProperties: false
properties:
group:
description: Refer to group_name under access
type: string
security_name:
type: string
type: object
tunnel_provider_options_zscaler_sub_location:
additionalProperties: false
properties:
aup_block_internet_until_accepted:
default: false
type: boolean
aup_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
type: boolean
aup_force_ssl_inspection:
default: false
description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
type: boolean
aup_timeout_in_days:
description: Required if `aup_enabled`==`true`. Days before AUP is requested again
maximum: 180
minimum: 1
type: integer
auth_required:
default: false
description: Enable this option to authenticate users
type: boolean
caution_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
type: boolean
dn_bandwidth:
description: Download bandwidth cap of the link, in Mbps. Disabled if not set
examples:
- 200
format: double
maximum: 99999
minimum: 0.1
type:
- number
- 'null'
idle_time_in_minutes:
description: Required if `surrogate_IP`==`true`, idle Time to Disassociation
maximum: 43200
minimum: 0
type: integer
name:
description: '[network]($h/Orgs%20Networks/_overview) name'
type: string
ofw_enabled:
default: false
description: If `true`, enable the firewall control option
type: boolean
surrogate_IP:
default: false
description: Can only be `true` when `auth_required`==`true`. Map a user to a private IP address so it applies the user's policies, instead of the location's policies
type: boolean
surrogate_IP_enforced_for_known_browsers:
description: Can only be `true` when `surrogate_IP`==`true`, enforce surrogate IP for known browsers
type: boolean
surrogate_refresh_time_in_minutes:
description: Required if `surrogate_IP_enforced_for_known_browsers`==`true`, must be lower or equal than `idle_time_in_minutes`, refresh Time for re-validation of Surrogacy
maximum: 43200
minimum: 1
type: integer
up_bandwidth:
description: Download bandwidth cap of the link, in Mbps. Disabled if not set
examples:
- 200
format: double
maximum: 99999
minimum: 0.1
type:
- number
- 'null'
type: object
snmpv3_config_notify_items:
additionalProperties: false
properties:
name:
type: string
tag:
type: string
type:
$ref: '#/components/schemas/snmpv3_config_notify_type'
type: object
gateway_ip_config_property:
additionalProperties: false
properties:
ip:
format: ipv4
type: string
ip6:
format: ipv6
type: string
netmask:
examples:
- /24
type: string
netmask6:
examples:
- 2001:db8:abcd:12::1
type: string
secondary_ips:
$ref: '#/components/schemas/gateway_ip_config_property_second_ips'
type:
$ref: '#/components/schemas/ip_type'
type6:
$ref: '#/components/schemas/ip_type6'
type: object
switch_radius:
additionalProperties: false
description: By default, `radius_config` will be used. if a different one has to be used set `use_different_radius
properties:
enabled:
type: boolean
radius_config:
$ref: '#/components/schemas/switch_radius_config'
use_different_radius:
type: string
type: object
acl_tag_type:
description: "enum: \n * `any`: matching anything not identified\n * `dynamic_gbp`: from the gbp_tag received from RADIUS\n * `gbp_resource`: can only be used in `dst_tags`\n * `mac`\n * `network`\n * `port_usage`\n * `radius_group`\n * `resource`: can only be used in `dst_tags`\n * `static_gbp`: applying gbp tag against matching conditions\n * `subnet`'"
enum:
- any
- dynamic_gbp
- gbp_resource
- mac
- network
- port_usage
- radius_group
- resource
- static_gbp
- subnet
type: string
radio_band_antenna_beam_pattern:
description: 'enum: `narrow`, `medium`, `wide`'
enum:
- narrow
- medium
- wide
type: string
vrrp_config_groups:
additionalProperties:
$ref: '#/components/schemas/vrrp_config_group'
description: Property key is the VRRP name
type: object
ospf_area_type:
default: default
description: 'OSPF type. enum: `default`, `nssa`, `stub`'
enum:
- default
- nssa
- stub
examples:
- default
type: string
tunnel_config_auto_provision_node:
properties:
probe_ips:
$ref: '#/components/schemas/strings'
wan_names:
$ref: '#/components/schemas/tunnel_config_auto_provision_node_wan_names'
ap_client_bridge_auth:
additionalProperties: false
properties:
psk:
examples:
- foryoureyesonly
maxLength: 63
minLength: 8
type: string
type:
$ref: '#/components/schemas/ap_client_bridge_auth_type'
type: object
idp_profile_overwrites:
items:
$ref: '#/components/schemas/idp_profile_overwrite'
type: array
network_vpn_access:
additionalProperties:
$ref: '#/components/schemas/network_vpn_access_config'
description: Property key is the VPN name. Whether this network can be accessed from vpn
type: object
network_vpn_access_destination_nat:
additionalProperties:
$ref: '#/components/schemas/network_vpn_access_destination_nat_property'
description: Property key can be an External IP (i.e. "63.16.0.3"), an External IP:Port (i.e. "63.16.0.3:443"), an External Port (i.e. ":443"), an External CIDR (i.e. "63.16.0.0/30"), an External CIDR:Port (i.e. "63.16.0.0/30:443") or a Variable (i.e. "{{myvar}}"). At least one of the `internal_ip` or `port` must be defined
type: object
site_device_events_count_distinct:
default: model
description: 'enum: `mac`, `model`, `type`, `type_code`'
enum:
- mac
- model
- type
- type_code
type: string
acl_tag_spec:
additionalProperties: false
properties:
port_range:
default: '0'
description: Matched dst port, "0" means any
type: string
protocol:
default: any
description: '`tcp` / `udp` / `icmp` / `icmp6` / `gre` / `any` / `:protocol_number`, `protocol_number` is between 1-254, default is `any` `protocol_number` is between 1-254'
type: string
type: object
dhcpd_config_property:
additionalProperties: false
properties:
dns_servers:
$ref: '#/components/schemas/dhcpd_config_dns_servers'
dns_suffix:
$ref: '#/components/schemas/dhcpd_config_dns_suffix'
fixed_bindings:
$ref: '#/components/schemas/dhcpd_config_fixed_bindings'
gateway:
description: If `type`==`local` - optional, `ip` will be used if not provided
examples:
- 192.168.70.1
type: string
ip6_end:
description: If `type6`==`local`
examples:
- 2607:f8b0:4005:808::ff
type: string
ip6_start:
description: If `type6`==`local`
examples:
- 2607:f8b0:4005:808::2
type: string
ip_end:
description: If `type`==`local`
examples:
- 192.168.70.200
type: string
ip_start:
description: If `type`==`local`
examples:
- 192.168.70.100
type: string
lease_time:
default: 86400
description: In seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]
maximum: 604800
minimum: 3600
type: integer
options:
$ref: '#/components/schemas/dhcpd_config_options'
server_id_override:
default: false
description: "`server_id_override`==`true` means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, \nshould overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address."
type: boolean
servers:
$ref: '#/components/schemas/dhcpd_config_servers'
serversv6:
$ref: '#/components/schemas/dhcpd_config_servers6'
type:
$ref: '#/components/schemas/dhcpd_config_type'
type6:
$ref: '#/components/schemas/dhcpd_config_type6'
vendor_encapsulated:
$ref: '#/components/schemas/dhcpd_config_vendor_options'
type: object
sw_routing_policy_terms:
description: at least criteria/filter must be specified to match the term, all criteria have to be met
items:
$ref: '#/components/schemas/sw_routing_policy_term'
minItems: 1
type: array
uniqueItems: true
service_policy_syslog:
additionalProperties: false
description: Required for syslog logging
properties:
enabled:
default: false
type: boolean
server_names:
examples:
- - dc_syslog_server
items:
type: string
type: array
type: object
switch_iot_port_alarm_class:
default: minor
description: 'Alarm class for the switch iot port in. enum: `minor`, `major`'
enum:
- minor
- major
type: string
gateway_path_preferences_path_networks:
description: Required when `type`==`local`
items:
type: string
type: array
ssl_proxy_ciphers_category:
default: strong
description: 'enum: `medium`, `strong`, `weak`'
enum:
- medium
- strong
- weak
type: string
msp_id:
examples:
- b9d42c2e-88ee-41f8-b798-f009ce7fe909
format: uuid
readOnly: true
type: string
switch_stp_config:
additionalProperties: false
properties:
bridge_priority:
default: 32k
description: Switch STP priority. Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
examples:
- 40k
type: string
type: object
snmp_config_views:
items:
$ref: '#/components/schemas/snmp_config_view'
type: array
gw_routing_policy_term_action_export_communities:
description: When used as export policy, optional
items:
type: string
type: array
device_search_radius_stats:
additionalProperties:
$ref: '#/components/schemas/device_search_radius_stat'
description: Property key is the RADIUS server IP Address
type: object
switch_port_usage_dynamic_rule:
additionalProperties: false
properties:
description:
description: Optional description of the rule
type: string
equals:
type: string
equals_any:
$ref: '#/components/schemas/switch_port_usage_dynamic_rule_equals_any'
expression:
description: '"[0:3]":"abcdef" -> "abc"
"split(.)[1]": "a.b.c" -> "b"
"split(-)[1][0:3]: "a1234-b5678-c90" -> "b56"'
type: string
src:
$ref: '#/components/schemas/switch_port_usage_dynamic_rule_src'
usage:
description: '`port_usage` name'
type: string
required:
- src
type: object
remote_syslog_users:
items:
$ref: '#/components/schemas/remote_syslog_user'
type: array
gw_routing_policy_term_matching_route_exists:
additionalProperties: false
properties:
route:
examples:
- 192.168.0.0/24
type: string
vrf_name:
default: default
description: Name of the vrf instance, it can also be the name of the VPN or wan if they
type: string
type: object
ap_usb:
additionalProperties: false
description: "USB AP settings\n - Note: if native imagotag is enabled, BLE will be disabled automatically\n - Note: legacy, new config moved to ESL Config."
properties:
cacert:
description: Only if `type`==`imagotag`
type:
- string
- 'null'
channel:
description: Only if `type`==`imagotag`, channel selection, not needed by default, required for manual channel override only
examples:
- 3
type: integer
enabled:
description: Whether to enable any usb config
type: boolean
host:
description: Only if `type`==`imagotag`
examples:
- 1.1.1.1
type: string
port:
default: 0
description: Only if `type`==`imagotag`
examples:
- 0
type: integer
type:
$ref: '#/components/schemas/ap_usb_type'
verify_cert:
description: Only if `type`==`imagotag`, whether to turn on SSL verification
type: boolean
vlan_id:
default: 1
description: Only if `type`==`solum` or `type`==`hanshow`
type: integer
type: object
mac_addresses_macs:
examples:
- - 683b679ac024
items:
type: string
minItems: 1
type: array
uniqueItems: true
created_time:
description: When the object has been created, in epoch
format: double
readOnly: true
type: number
switch_port_usage:
additionalProperties: false
description: Junos port usages
properties:
all_networks:
default: false
description: Only if `mode`==`trunk`. Whether to trunk all network/vlans
type: boolean
allow_dhcpd:
description: 'Only applies when `mode`!=`dynamic`. Controls whether DHCP server traffic is allowed on ports using this configuration if DHCP snooping is enabled. This is a tri-state setting; `true`: ports become trusted ports allowing DHCP server traffic, `false`: ports become untrusted blocking DHCP server traffic, undefined: use system defaults (access ports default to untrusted, trunk ports default to trusted).'
type: boolean
allow_multiple_supplicants:
default: false
description: Only if `mode`!=`dynamic`
type: boolean
bypass_auth_when_server_down:
default: false
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Bypass auth for known clients if set to true when RADIUS server is down
type: boolean
bypass_auth_when_server_down_for_unknown_client:
default: false
description: Only if `mode`!=`dynamic` and `port_auth`=`dot1x`. Bypass auth for all (including unknown clients) if set to true when RADIUS server is down
type: boolean
bypass_auth_when_server_down_for_voip:
default: false
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Bypass auth for VOIP if set to true when RADIUS server is down
type: boolean
community_vlan_id:
description: Only if `mode`!=`dynamic`. To be used together with `isolation` under networks. Signaling that this port connects to the networks isolated but wired clients belong to the same community can talk to each other
type: integer
description:
description: Only if `mode`!=`dynamic`
type: string
disable_autoneg:
default: false
description: Only if `mode`!=`dynamic`. If speed and duplex are specified, whether to disable autonegotiation
type: boolean
disabled:
default: false
description: Only if `mode`!=`dynamic`. Whether the port is disabled
type: boolean
duplex:
$ref: '#/components/schemas/switch_port_usage_duplex'
dynamic_vlan_networks:
$ref: '#/components/schemas/switch_port_usage_dynamic_vlan_networks'
enable_mac_auth:
default: false
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Whether to enable MAC Auth
type: boolean
enable_qos:
default: false
description: Only if `mode`!=`dynamic`
type: boolean
guest_network:
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Which network to put the device into if the device cannot do dot1x. default is null (i.e. not allowed)
type:
- string
- 'null'
inter_isolation_network_link:
default: false
description: Only if `mode`!=`dynamic`. `inter_isolation_network_link` is used together with `isolation` under networks, signaling that this port connects to isolated networks
type: boolean
inter_switch_link:
default: false
description: 'Only if `mode`!=`dynamic`. `inter_switch_link` is used together with `isolation` under networks. NOTE: `inter_switch_link` works only between Juniper devices. This has to be applied to both ports connected together'
type: boolean
mac_auth_only:
description: Only if `mode`!=`dynamic` and `enable_mac_auth`==`true`
type: boolean
mac_auth_preferred:
description: Only if `mode`!=`dynamic` + `enable_mac_auth`==`true` + `mac_auth_only`==`false`, dot1x will be given priority then mac_auth. Enable this to prefer mac_auth over dot1x.
type: boolean
mac_auth_protocol:
$ref: '#/components/schemas/switch_port_usage_mac_auth_protocol'
mac_limit:
$ref: '#/components/schemas/switch_port_usage_mac_limit'
mode:
$ref: '#/components/schemas/switch_port_usage_mode'
mtu:
$ref: '#/components/schemas/switch_port_usage_mtu'
networks:
$ref: '#/components/schemas/switch_port_usage_networks'
persist_mac:
default: false
description: Only if `mode`==`access` and `port_auth`!=`dot1x`. Whether the port should retain dynamically learned MAC addresses
type: boolean
poe_disabled:
default: false
description: Only if `mode`!=`dynamic`. Whether PoE capabilities are disabled for a port
type: boolean
poe_keep_state_when_reboot:
default: false
description: Only if `mode`!=`dynamic`. Whether Perpetual PoE is enabled; keeps PoE state across reboots
type: boolean
poe_priority:
$ref: '#/components/schemas/poe_priority'
port_auth:
$ref: '#/components/schemas/switch_port_usage_dot1x'
port_network:
description: Only if `mode`!=`dynamic`. Native network/vlan for untagged traffic
type: string
reauth_interval:
$ref: '#/components/schemas/switch_port_usage_reauth_interval'
reset_default_when:
$ref: '#/components/schemas/switch_port_usage_dynamic_reset_default_when'
rules:
$ref: '#/components/schemas/switch_port_usage_dynamic_rules'
server_fail_network:
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. Sets server fail fallback vlan
type:
- string
- 'null'
server_reject_network:
description: Only if `mode`!=`dynamic` and `port_auth`==`dot1x`. When radius server reject / fails
type:
- string
- 'null'
speed:
$ref: '#/components/schemas/switch_port_usage_speed'
storm_control:
$ref: '#/components/schemas/switch_port_usage_storm_control'
stp_disable:
default: false
description: Only if `mode`!=`dynamic` and `stp_required`==`false`. Drop bridge protocol data units (BPDUs ) that enter any interface or a specified interface
type: boolean
stp_edge:
default: false
description: Only if `mode`!=`dynamic`. When enabled, the port is not expected to receive BPDU frames
type: boolean
stp_no_root_port:
default: false
description: Only if `mode`!=`dynamic`
type: boolean
stp_p2p:
default: false
description: Only if `mode`!=`dynamic`
type: boolean
stp_required:
default: false
description: Only if `mode`!=`dynamic`. Whether to remain in block state if no BPDU is received
type: boolean
ui_evpntopo_id:
description: Optional for Campus Fabric Core-Distribution ESI-LAG profile. Helper used by the UI to select this port profile as the ESI-Lag between Distribution and Access switches
format: uuid
type: string
use_vstp:
default: false
description: If this is connected to a vstp network
type: boolean
voip_network:
description: Only if `mode`!=`dynamic`. Network/vlan for voip traffic, must also set port_network. to authenticate device, set port_auth
type:
- string
- 'null'
type: object
aggregate_routes:
additionalProperties:
$ref: '#/components/schemas/aggregate_route'
description: Property key is the destination subnet (e.g. "172.16.3.0/24")
examples:
- 172.16.3.0/24:
discard: false
metric: null
preference: 30
type: object
service_policy_ewf:
items:
$ref: '#/components/schemas/service_policy_ewf_rule'
type: array
switch_virtual_chassis_members:
description: List of Virtual Chassis members
items:
$ref: '#/components/schemas/switch_virtual_chassis_member'
type: array
snmp_usm_user_encryption_type:
description: 'enum: `privacy-3des`, `privacy-aes128`, `privacy-des`, `privacy-none`'
enum:
- privacy-3des
- privacy-aes128
- privacy-des
- privacy-none
type: string
remote_syslog_content:
additionalProperties: false
properties:
facility:
$ref: '#/components/schemas/remote_syslog_facility'
severity:
$ref: '#/components/schemas/remote_syslog_severity'
type: object
gateway_vrf_instance:
additionalProperties: false
examples:
- networks:
- CORP_NET
- MGMT_NET
properties:
networks:
$ref: '#/components/schemas/strings'
type: object
network_tenant:
additionalProperties: false
properties:
addresses:
$ref: '#/components/schemas/network_tenant_addresses'
type: object
ble_config:
additionalProperties: false
description: BLE AP settings
properties:
beacon_enabled:
default: true
description: Whether Mist beacons is enabled
type: boolean
beacon_rate:
description: Required if `beacon_rate_mode`==`custom`, 1-10, in number-beacons-per-second
examples:
- 3
type: integer
beacon_rate_mode:
$ref: '#/components/schemas/ble_config_beacon_rate_mode'
beam_disabled:
$ref: '#/components/schemas/ble_config_beam_disabled'
custom_ble_packet_enabled:
default: false
description: Can be enabled if `beacon_enabled`==`true`, whether to send custom packet
type: boolean
custom_ble_packet_frame:
default: ''
description: The custom frame to be sent out in this beacon. The frame must be a hexstring
examples:
- 0x........
type: string
custom_ble_packet_freq_msec:
default: 0
description: Frequency (msec) of data emitted by custom ble beacon
examples:
- 300
minimum: 0
type: integer
eddystone_uid_adv_power:
default: 0
description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
examples:
- -65
maximum: 20
minimum: -100
type: integer
eddystone_uid_beams:
default: ''
examples:
- 2-4,7
type: string
eddystone_uid_enabled:
default: false
description: Only if `beacon_enabled`==`false`, Whether Eddystone-UID beacon is enabled
type: boolean
eddystone_uid_freq_msec:
default: 0
description: Frequency (msec) of data emit by Eddystone-UID beacon
examples:
- 200
type: integer
eddystone_uid_instance:
default: ''
description: Eddystone-UID instance for the device
examples:
- 5c5b35000001
type: string
eddystone_uid_namespace:
default: ''
description: Eddystone-UID namespace
examples:
- 2818e3868dec25629ede
type: string
eddystone_url_adv_power:
default: 0
description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
examples:
- -65
maximum: 20
minimum: -100
type: integer
eddystone_url_beams:
default: ''
examples:
- 2-4,7
type: string
eddystone_url_enabled:
default: false
description: Only if `beacon_enabled`==`false`, Whether Eddystone-URL beacon is enabled
type: boolean
eddystone_url_freq_msec:
default: 0
description: Frequency (msec) of data emit by Eddystone-UID beacon
examples:
- 1000
type: integer
eddystone_url_url:
default: ''
description: URL pointed by Eddystone-URL beacon
examples:
- https://www.abc.com
type: string
ibeacon_adv_power:
default: 0
description: Advertised TX Power, -100 to 20 (dBm), omit this attribute to use default
examples:
- -65
maximum: 20
minimum: -100
type: integer
ibeacon_beams:
default: ''
examples:
- 2-4,7
type: string
ibeacon_enabled:
default: false
description: Can be enabled if `beacon_enabled`==`true`, whether to send iBeacon
type: boolean
ibeacon_freq_msec:
default: 0
description: Frequency (msec) of data emit for iBeacon
type: integer
ibeacon_major:
$ref: '#/components/schemas/ibeacon_major'
ibeacon_minor:
$ref: '#/components/schemas/ibeacon_minor'
ibeacon_uuid:
default: ''
description: Optional, if not specified, the same UUID as the beacon will be used
examples:
- f3f17139-704a-f03a-2786-0400279e37c3
format: uuid
type: string
power:
default: 9
description: Required if `power_mode`==`custom`; else use `power_mode` as default
examples:
- 6
maximum: 10
minimum: 1
type: integer
power_mode:
$ref: '#/components/schemas/ble_config_power_mode'
type: object
service_policy_skyatp:
additionalProperties: false
description: SRX only
properties:
dns_dga_detection:
$ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection'
dns_tunnel_detection:
$ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection'
http_inspection:
$ref: '#/components/schemas/service_policy_skyatp_http_inspection'
iot_device_policy:
$ref: '#/components/schemas/service_policy_skyatp_iot_device_policy'
type: object
ospf_area:
additionalProperties: false
description: Property key is the OSPF Area (Area should be a number (0-255) / IP address)
properties:
include_loopback:
default: false
type: boolean
networks:
additionalProperties:
$ref: '#/components/schemas/ospf_areas_network'
examples:
- corp:
auth_keys:
'1': auth-key-1
auth_type: md5
bfd_minimum_interval: 500
dead_interval: 40
hello_interval: 10
interface_type: nbma
metric: 10000
guest:
passive: true
type: object
type:
$ref: '#/components/schemas/ospf_area_type'
type: object
switch_port_usage_dynamic_rule_src:
description: 'enum: `link_peermac`, `lldp_chassis_id`, `lldp_hardware_revision`, `lldp_manufacturer_name`, `lldp_oui`, `lldp_serial_number`, `lldp_system_description`, `lldp_system_name`, `radius_dynamicfilter`, `radius_usermac`, `radius_username`'
enum:
- link_peermac
- lldp_chassis_id
- lldp_hardware_revision
- lldp_manufacturer_name
- lldp_oui
- lldp_serial_number
- lldp_system_description
- lldp_system_name
- radius_dynamicfilter
- radius_usermac
- radius_username
type: string
ap_iot_input:
additionalProperties: false
description: IoT Input AP settings
properties:
enabled:
default: false
description: Whether to enable a pin
type: boolean
name:
description: Optional; descriptive pin name
examples:
- motion
type: string
pullup:
$ref: '#/components/schemas/ap_iot_pullup'
type: object
dhcpd_config_option_type:
description: 'enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`'
enum:
- boolean
- hex
- int16
- int32
- ip
- string
- uint16
- uint32
type: string
tunnel_via:
default: primary
description: 'If `via`==`tunnel`, specifies which tunnel (primary/secondary) this neighbor is associated with. enum: `primary`, `secondary`'
enum:
- primary
- secondary
type: string
tunnel_config_node_wan_names:
items:
type: string
type: array
device_search_radius_filter_status:
description: 'Status of the device search radius filter. enum: `up`, `down`, `unreachable`'
enum:
- up
- down
- unreachable
type: string
wired_port_config:
additionalProperties:
$ref: '#/components/schemas/junos_port_config'
description: Property key is the port name or range (e.g. "ge-0/0/0-10")
type: object
gw_routing_policy_term_matching:
additionalProperties: false
description: zero or more criteria/filter can be specified to match the term, all criteria have to be met
properties:
as_path:
$ref: '#/components/schemas/routing_policy_term_matching_as_path'
community:
$ref: '#/components/schemas/routing_policy_term_matching_community'
network:
$ref: '#/components/schemas/strings'
prefix:
$ref: '#/components/schemas/routing_policy_term_matching_prefix'
protocol:
$ref: '#/components/schemas/gw_routing_policy_term_matching_protocol'
route_exists:
$ref: '#/components/schemas/gw_routing_policy_term_matching_route_exists'
vpn_neighbor_mac:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_neighbor_mac'
vpn_path:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path'
vpn_path_sla:
$ref: '#/components/schemas/gw_routing_policy_term_matching_vpn_path_sla'
type: object
bgp_as:
anyOf:
- type: string
- maximum: 4294967294
minimum: 1
type: integer
description: BGP AS, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}` )
examples:
- 65000
ap_port_config:
additionalProperties: false
properties:
disabled:
default: false
type: boolean
dynamic_vlan:
$ref: '#/components/schemas/ap_port_config_dynamic_vlan'
enable_mac_auth:
default: false
type: boolean
forwarding:
$ref: '#/components/schemas/ap_port_config_forwarding'
mac_auth_preferred:
default: false
description: When `true`, we'll do dot1x then mac_auth. enable this to prefer mac_auth
type: boolean
mac_auth_protocol:
$ref: '#/components/schemas/ap_port_config_mac_auth_protocol'
mist_nac:
$ref: '#/components/schemas/wlan_mist_nac'
mx_tunnel_id:
default: ''
description: If `forwarding`==`mxtunnel`, vlan_ids comes from mxtunnel
examples:
- 08cd7499-5841-51c8-e663-fb16b6f3b45e
format: uuid
type: string
mxtunnel_name:
default: ''
description: If `forwarding`==`site_mxedge`, vlan_ids comes from site_mxedge (`mxtunnels` under site setting)
type: string
port_auth:
$ref: '#/components/schemas/ap_port_config_port_auth'
port_vlan_id:
description: If `forwarding`==`limited`
examples:
- 1
maximum: 4094
minimum: 1
type: integer
radius_config:
$ref: '#/components/schemas/radius_config'
radsec:
$ref: '#/components/schemas/radsec'
vlan_id:
description: "Optional to specify the vlan id for a tunnel if forwarding is for `wxtunnel`, `mxtunnel` or `site_mxedge`.\n * if vlan_id is not specified then it will use first one in vlan_ids[] of the mxtunnel.\n * if forwarding == site_mxedge, vlan_ids comes from site_mxedge (`mxtunnels` under site setting)"
examples:
- 9
maximum: 4094
minimum: 1
type: integer
vlan_ids:
description: If `forwarding`==`limited`, comma separated list of additional vlan ids allowed on this port
examples:
- 10,20,30
type: string
wxtunnel_id:
default: ''
description: If `forwarding`==`wxtunnel`, the port is bridged to the vlan of the session
examples:
- 7dae216d-7c98-a51b-e068-dd7d477b7216
format: uuid
type: string
wxtunnel_remote_id:
default: ''
description: If `forwarding`==`wxtunnel`, the port is bridged to the vlan of the session
examples:
- wifiguest
type: string
type: object
gw_routing_policy:
additionalProperties: false
properties:
terms:
$ref: '#/components/schemas/gw_routing_policy_terms'
type: object
switch_mgmt_mxedge_proxy_port:
anyOf:
- default: 2222
maximum: 65535
minimum: 1
type: integer
- type: string
description: Mist Edge port used to proxy the switch management traffic to the Mist Cloud. Value in range 1-65535
remote_syslog_files:
items:
$ref: '#/components/schemas/remote_syslog_file_config'
type: array
snmp_config_view:
additionalProperties: false
properties:
include:
description: If the root oid configured is included
type: boolean
oid:
examples:
- 1.3.6.1
type: string
view_name:
examples:
- all
type: string
type: object
response_http429:
additionalProperties: false
properties:
detail:
examples:
- Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
type: string
type: object
ap_port_config_dynamic_vlan:
additionalProperties: false
description: Optional dynamic vlan
properties:
default_vlan_id:
examples:
- 999
maximum: 4094
minimum: 1
type: integer
enabled:
type: boolean
type:
type: string
vlans:
additionalProperties:
type:
- string
- 'null'
examples:
- 1-10: null
user: null
type: object
type: object
idp_profile_action:
default: alert
description: "enum:\n * alert (default)\n * drop: silently dropping packets\n * close: notify client/server to close connection"
enum:
- alert
- close
- drop
examples:
- alert
type: string
gateway_vrf_instances:
additionalProperties:
$ref: '#/components/schemas/gateway_vrf_instance'
description: Property key is the network name
examples:
- CORP_VRF:
networks:
- CORP_NET
- MGMT_NET
type: object
gateway_traffic_shaping_class_percentages:
description: 'percentages for different class of traffic: high / medium / low / best-effort. Sum must be equal to 100'
items:
type: integer
type: array
vrrp_config:
additionalProperties: false
description: Junos VRRP config
properties:
enabled:
type: boolean
groups:
$ref: '#/components/schemas/vrrp_config_groups'
type: object
ap_iot_pullup:
default: none
description: 'the type of pull-up the pin uses. enum: `external`, `internal`, `none`'
enum:
- external
- internal
- none
type: string
ap_iot:
additionalProperties: false
description: IoT AP settings
properties:
A1:
$ref: '#/components/schemas/ap_iot_output'
A2:
$ref: '#/components/schemas/ap_iot_output'
A3:
$ref: '#/components/schemas/ap_iot_output'
A4:
$ref: '#/components/schemas/ap_iot_output'
DI1:
$ref: '#/components/schemas/ap_iot_input'
DI2:
$ref: '#/components/schemas/ap_iot_input'
DO:
$ref: '#/components/schemas/ap_iot_output'
type: object
routing_policy_term_action_community:
description: When used as export policy, optional
items:
examples:
- '3900190'
type: string
type: array
junos_other_ip_config:
additionalProperties: false
description: Optional, if it's required to have switch's L3 presence on a network/vlan
properties:
evpn_anycast:
default: false
description: For EVPN, if anycast is desired
type: boolean
ip:
description: Required if `type`==`static`
examples:
- 10.3.3.1
type: string
ip6:
description: Required if `type6`==`static`
examples:
- fdad:b0bc:f29e::3d16
type: string
netmask:
description: Optional, `subnet` from `network` definition will be used if defined
examples:
- 255.255.255.0
type: string
netmask6:
description: Optional, `subnet` from `network` definition will be used if defined
examples:
- /64
type: string
type:
$ref: '#/components/schemas/ip_type'
type6:
$ref: '#/components/schemas/ip_type6'
type: object
acl_policy:
additionalProperties: false
description: "ACL Policy:\n - for GBP-based policy, all src_tags and dst_tags have to be gbp-based\n - for ACL-based policy, `network` is required in either the source or destination so that we know where to attach the policy to"
properties:
actions:
$ref: '#/components/schemas/acl_policy_actions'
name:
examples:
- guest access
type: string
src_tags:
$ref: '#/components/schemas/acl_policy_src_tags'
type: object
wan_extra_routes:
additionalProperties: false
properties:
via:
format: ipv4
type: string
type: object
service_policy_secintel:
additionalProperties: false
description: SRX only
properties:
enabled:
default: false
type: boolean
profile:
$ref: '#/components/schemas/service_policy_secintel_profile'
secintelprofile_id:
description: org-level secintel Profile can be used, this takes precedence over 'profile'
type: string
type: object
gw_routing_policy_term_action_exclude_as_path:
description: When used as export policy, optional. To exclude certain AS
items:
examples:
- '65002'
type: string
type: array
switch_mgmt:
additionalProperties: false
description: Switch Management settings
properties:
ap_affinity_threshold:
default: 10
description: AP_affinity_threshold ap_affinity_threshold can be added as a field under site/setting. By default, this value is set to 12. If the field is set in both site/setting and org/setting, the value from site/setting will be used.
type: integer
cli_banner:
description: Set Banners for switches. Allows markup formatting
examples:
- \t\tWELCOME!
type: string
cli_idle_timeout:
description: Sets timeout for switches
maximum: 60
minimum: 1
type: integer
config_revert_timer:
default: 10
description: Rollback timer for commit confirmed
maximum: 30
minimum: 1
type: integer
dhcp_option_fqdn:
default: false
description: Enable to provide the FQDN with DHCP option 81
type: boolean
disable_oob_down_alarm:
type: boolean
fips_enabled:
default: false
type: boolean
local_accounts:
$ref: '#/components/schemas/config_switch_local_accounts'
mxedge_proxy_host:
description: IP Address or FQDN of the Mist Edge used to proxy the switch management traffic to the Mist Cloud
type: string
mxedge_proxy_port:
$ref: '#/components/schemas/switch_mgmt_mxedge_proxy_port'
protect_re:
$ref: '#/components/schemas/protect_re'
radius:
$ref: '#/components/schemas/switch_radius'
remove_existing_configs:
default: false
description: By default, only the configuration generated by Mist is cleaned up during the configuration process. If `true`, all the existing configuration will be removed.
type: boolean
root_password:
format: password
type: string
tacacs:
$ref: '#/components/schemas/tacacs'
use_mxedge_proxy:
description: To use mxedge as proxy
type: boolean
type: object
ip_type6:
default: disabled
description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`'
enum:
- autoconf
- dhcp
- disabled
- static
examples:
- static
type: string
acl_policies:
items:
$ref: '#/components/schemas/acl_policy'
type: array
gateway_mgmt:
additionalProperties: false
description: Gateway Management settings
properties:
admin_sshkeys:
$ref: '#/components/schemas/gateway_mgmt_admin_sshkeys'
app_probing:
$ref: '#/components/schemas/app_probing'
app_usage:
description: Consumes uplink bandwidth, requires WA license
type: boolean
auto_signature_update:
$ref: '#/components/schemas/gateway_mgmt_auto_signature_update'
config_revert_timer:
default: 10
description: Rollback timer for commit confirmed
maximum: 30
minimum: 1
type: integer
disable_console:
default: false
description: For SSR and SRX, disable console port
type: boolean
disable_oob:
default: false
description: For SSR and SRX, disable management interface
type: boolean
disable_usb:
default: false
description: For SSR and SRX, disable usb interface
type: boolean
fips_enabled:
default: false
type: boolean
probe_hosts:
$ref: '#/components/schemas/gateway_mgmt_probe_hosts'
probe_hostsv6:
$ref: '#/components/schemas/gateway_mgmt_probe_hostsv6'
protect_re:
$ref: '#/components/schemas/protect_re'
root_password:
description: SRX only
format: password
type: string
security_log_source_address:
examples:
- 192.168.1.1
format: ipv4
type: string
security_log_source_interface:
examples:
- ge-0/0/1.0
type: string
type: object
gateway_port_wan_source_nat:
additionalProperties: false
description: Only if `usage`==`wan`, optional. By default, source-NAT is performed on all WAN Ports using the interface-ip
properties:
disabled:
default: false
description: Or to disable the source-nat
type: boolean
nat6_pool:
description: If alternative nat_pool is desired
examples:
- 2601:1700:43c0:dc0:20c:29ff:fea7:93bc/126
type: string
nat_pool:
description: If alternative nat_pool is desired
examples:
- 64.2.4.0/30
type: string
type: object
network_internet_access_destination_nat:
additionalProperties:
$ref: '#/components/schemas/network_internet_access_destination_nat_property'
description: Property key can be an External IP (i.e. "63.16.0.3"), an External IP:Port (i.e. "63.16.0.3:443"), an External Port (i.e. ":443"), an External CIDR (i.e. "63.16.0.0/30"), an External CIDR:Port (i.e. "63.16.0.0/30:443") or a Variable (i.e. "{{myvar}}"). At least one of the `internal_ip` or `port` must be defined
type: object
gateway_port_vpn_paths:
additionalProperties:
$ref: '#/components/schemas/gateway_port_vpn_path'
description: Property key is the VPN name
type: object
snmpv3_config_target_param_security_level:
description: 'enum: `authentication`, `none`, `privacy`'
enum:
- authentication
- none
- privacy
type: string
ap_esl_type:
description: 'note: ble_config will be ignored if esl_config is enabled and with native mode. enum: `hanshow`, `imagotag`, `native`, `solum`'
enum:
- hanshow
- imagotag
- native
- solum
examples:
- imagotag
type: string
switch_port_usage_dynamic_reset_default_when:
default: link_down
description: 'Only if `mode`==`dynamic` Control when the DPC port should be changed to the default port usage. enum: `link_down`, `none` (let the DPC port keep at the current port usage)'
enum:
- link_down
- none
examples:
- link_down
type: string
search_site_devices_mxtunnel_status:
description: 'enum: `down`, `up`'
enum:
- down
- up
type: string
tunnel_provider_options_zscaler:
additionalProperties: false
description: For zscaler-ipsec and zscaler-gre
properties:
aup_block_internet_until_accepted:
default: false
type: boolean
aup_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display Acceptable Use Policy (AUP)
type: boolean
aup_force_ssl_inspection:
default: false
description: Proxy HTTPs traffic, requiring Zscaler cert to be installed in browser
type: boolean
aup_timeout_in_days:
description: Required if `aup_enabled`==`true`. Days before AUP is requested again
maximum: 180
minimum: 1
type: integer
auth_required:
default: false
description: Enable this option to enforce user authentication
type: boolean
caution_enabled:
default: false
description: Can only be `true` when `auth_required`==`false`, display caution notification for non-authenticated users
type: boolean
dn_bandwidth:
description: Download bandwidth cap of the link, in Mbps. Disabled if not set
examples:
- 200
format: double
maximum: 99999
minimum: 0.1
type:
- number
- 'null'
idle_time_in_minutes:
description: Required if `surrogate_IP`==`true`, idle Time to Disassociation
maximum: 43200
minimum: 0
type: integer
ofw_enabled:
default: false
description: If `true`, enable the firewall control option
type: boolean
sub_locations:
$ref: '#/components/schemas/zscaler_sub_locations'
surrogate_IP:
default: false
description: Can only be `true` when `auth_required`==`true`. Map a user to a private IP address so it applies the user's policies, instead of the location's policies
type: boolean
surrogate_IP_enforced_for_known_browsers:
description: Can only be `true` when `surrogate_IP`==`true`, enforce surrogate IP for known browsers
type: boolean
surrogate_refresh_time_in_minutes:
description: Required if `surrogate_IP_enforced_for_known_browsers`==`true`, must be lower or equal than `idle_time_in_minutes`, refresh Time for re-validation of Surrogacy
maximum: 43200
minimum: 1
type: integer
up_bandwidth:
description: Download bandwidth cap of the link, in Mbps. Disabled if not set
examples:
- 200
format: double
maximum: 99999
minimum: 0.1
type:
- number
- 'null'
xff_forward_enabled:
default: false
description: Location uses proxy chaining to forward traffic
type: boolean
type: object
idp_profile_matching_dst_subnet:
items:
examples:
- 63.1.2.0/24
type: string
type: array
response_http403:
additionalProperties: false
properties:
detail:
examples:
- You do not have permission to perform this action.
type: string
type: object
gateway_wan_type:
default: dhcp
description: 'enum: `dhcp`, `pppoe`, `static`'
enum:
- dhcp
- pppoe
- static
type: string
response_events_devices:
additionalProperties: false
properties:
end:
type: integer
limit:
type: integer
next:
type: string
results:
$ref: '#/components/schemas/device_events'
start:
type: integer
total:
type: integer
required:
- end
- limit
- results
- start
- total
type: object
count_results:
items:
$ref: '#/components/schemas/count_result'
type: array
uniqueItems: true
aggregate_routes6:
additionalProperties:
$ref: '#/components/schemas/aggregate_route'
description: Property key is the destination subnet (e.g. "2a02:1234:420a:10c9::/64")
example:
2a02:1234:420a:10c9::/64:
discard: false
metric: null
preference: 30
type: object
ap_client_bridge:
additionalProperties: false
properties:
auth:
$ref: '#/components/schemas/ap_client_bridge_auth'
enabled:
default: false
description: "When acted as client bridge:\n * only 5G radio can be used\n * will not serve as AP on any radios"
type: boolean
ssid:
examples:
- Uplink-SSID
minLength: 1
type: string
type: object
snmp_vacm_security_model:
description: 'enum: `usm`, `v1`, `v2c`'
enum:
- usm
- v1
- v2c
type: string
switch_port_mirroring_property:
additionalProperties: false
properties:
input_networks_ingress:
$ref: '#/components/schemas/switch_port_mirroring_ingress_networks'
input_port_ids_egress:
$ref: '#/components/schemas/switch_port_mirroring_egress_port_ids'
input_port_ids_ingress:
$ref: '#/components/schemas/switch_port_mirroring_ingress_port_ids'
output_ip_address:
description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
examples:
- 1.2.3.4
type: string
output_network:
description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
examples:
- analyze
type: string
output_port_id:
description: Exactly one of the `output_ip_address`, `output_port_id` or `output_network` should be provided
examples:
- ge-0/0/5
type: string
type: object
snmp_vacm_access_item_prefix_list_item_model:
description: 'enum: `any`, `usm`, `v1`, `v2c`'
enum:
- any
- usm
- v1
- v2c
type: string
snmp_vacm_access_item:
additionalProperties: false
properties:
group_name:
type: string
prefix_list:
$ref: '#/components/schemas/snmp_vacm_access_item_prefix_list'
type: object
idp_profile_base_profile:
description: 'enum: `critical`, `standard`, `strict`'
enum:
- critical
- standard
- strict
examples:
- strict
type: string
webhook_device_events_event_ev_type:
description: '(optional) event advisory. enum: `notice`, `warn`'
enum:
- notice
- warn
type: string
const_device_type_ap:
description: 'Device Type. enum: `ap`'
enum:
- ap
readOnly: true
type: string
gw_routing_policy_term_matching_vpn_neighbor_mac:
description: overlay-facing criteria (used for bgp_config where via=vpn)
items:
type: string
type: array
switch_network:
additionalProperties: false
description: A network represents a network segment. It can either represent a VLAN (then usually ties to a L3 subnet), optionally associate it with a subnet which can later be used to create addition routes. Used for ports doing `family ethernet-switching`. It can also be a pure L3-subnet that can then be used against a port that with `family inet`.
properties:
gateway:
description: Only required for EVPN-VXLAN networks, IPv4 Virtual Gateway
type: string
gateway6:
description: Only required for EVPN-VXLAN networks, IPv6 Virtual Gateway
type: string
isolation:
default: false
description: 'whether to stop clients to talk to each other, default is false (when enabled, a unique isolation_vlan_id is required). NOTE: this features requires uplink device to also a be Juniper device and `inter_switch_link` to be set. See also `inter_isolation_network_link` and `community_vlan_id` in port_usage'
type: boolean
isolation_vlan_id:
examples:
- '3070'
type: string
subnet:
description: Optional for pure switching, required when L3 / routing features are used
type: string
subnet6:
description: Optional for pure switching, required when L3 / routing features are used
type: string
vlan_id:
$ref: '#/components/schemas/vlan_id_with_variable'
required:
- vlan_id
type: object
snmpv3_config_target_param_mess_process_model:
description: 'enum: `v1`, `v2c`, `v3`'
enum:
- v1
- v2c
- v3
type: string
response_http400:
additionalProperties: false
properties:
detail:
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
extra_routes:
additionalProperties:
$ref: '#/components/schemas/extra_route'
description: Property key is the destination CIDR (e.g. "10.0.0.0/8")
examples:
- 0.0.0.0/0:
via: 192.168.1.10
type: object
extra_route_next_qualified_properties:
additionalProperties: false
properties:
metric:
type:
- integer
- 'null'
preference:
type:
- integer
- 'null'
type: object
vrf_extra_routes:
additionalProperties:
$ref: '#/components/schemas/vrf_extra_route'
description: Property key is the destination CIDR (e.g. "10.0.0.0/8")
examples:
- 0.0.0.0/0:
via: 192.168.1.10
type: object
dot11_bandwidth6:
default: 80
description: 'channel width for the 6GHz band. enum: `0`(disabled, response only), `20`, `40`, `80`, `160`'
enum:
- 0
- 20
- 40
- 80
- 160
examples:
- 80
type: integer
tunnel_config_networks:
description: If `provider`==`custom-ipsec` or `provider`==`prisma-ipsec`, networks reachable via this tunnel
items:
type: string
type: array
switch_dhcpd_config_type6:
default: none
description: 'enum: `none`, `relay` (DHCP Relay), `server` (DHCP Server)'
enum:
- none
- relay
- server
type: string
radio_band_channels:
default: []
description: For RFTemplates. List of channels, null or empty array means auto
items:
type: integer
type:
- array
- 'null'
last_config_device_type:
default: ap
description: 'enum: `ap`, `gateway`, `mxedge`, `switch`'
enum:
- ap
- gateway
- switch
- mxedge
type: string
bgp_config_via:
default: lan
description: 'enum: `lan`, `tunnel`, `vpn`, `wan`'
enum:
- lan
- tunnel
- vpn
- wan
type: string
snmpv3_config_notify_filter_item:
additionalProperties: false
properties:
contents:
$ref: '#/components/schemas/snmpv3_config_notify_filter_item_contents'
profile_name:
type: string
type: object
dot11_band:
description: 'enum: `24`, `5`, `5-dedicated`, `5-selectable`, `6`, `6-dedicated`, `6-selectable`'
enum:
- '24'
- '5'
- 5-dedicated
- 5-selectable
- '6'
- 6-dedicated
- 6-selectable
type: string
remote_syslog_time_format:
description: 'enum: `millisecond`, `year`, `year millisecond`'
enum:
- millisecond
- year
- year millisecond
examples:
- millisecond
type: string
tacacs_auth_server:
additionalProperties: false
properties:
host:
type: string
port:
type: string
secret:
format: password
type: string
timeout:
default: 10
type: integer
type: object
tunnel_config_version:
default: '2'
description: 'Only if `provider`==`custom-gre` or `provider`==`custom-ipsec`. enum: `1`, `2`'
enum:
- '1'
- '2'
type: string
tunnel_config_ipsec_proposals:
description: Only if `provider`==`custom-ipsec`
items:
$ref: '#/components/schemas/tunnel_config_ipsec_proposal'
type: array
switch_port_mirroring_ingress_networks:
description: At least one of the `input_port_ids_ingress`, `input_port_ids_egress` or `input_networks_ingress ` should be specified
items:
examples:
- corp
type: string
type: array
modified_time:
description: When the object has been modified for the last time, in epoch
format: double
readOnly: true
type: number
acl_policy_actions:
description: "ACL Policy Actions:\n - for GBP-based policy, all src_tags and dst_tags have to be gbp-based\n - for ACL-based policy, `network` is required in either the source or destination so that we know where to attach the policy to"
items:
$ref: '#/components/schemas/acl_policy_action'
type: array
gw_routing_policy_term_matching_protocol:
items:
$ref: '#/components/schemas/gw_routing_policy_term_matching_protocol_enum'
type: array
tunnel_config_ipsec_proposal:
additionalProperties: false
properties:
auth_algo:
$ref: '#/components/schemas/tunnel_config_auth_algo'
dh_group:
$ref: '#/components/schemas/tunnel_config_dh_group'
enc_algo:
$ref: '#/components/schemas/tunnel_config_enc_algo'
type: object
config_device:
discriminator:
mapping:
ap: '#/components/schemas/device_ap'
gateway: '#/components/schemas/device_gateway'
switch: '#/components/schemas/device_switch'
propertyName: type
oneOf:
- $ref: '#/components/schemas/device_ap'
- $ref: '#/components/schemas/device_switch'
- $ref: '#/components/schemas/device_gateway'
acl_tag_macs:
description: "Required if \n- `type`==`mac`\n- `type`==`static_gbp` if from matching mac"
items:
type: string
type: array
gateway_oob_ip_config:
additionalProperties: false
description: Out-of-band (vme/em0/fxp0) IP config
properties:
gateway:
description: If `type`==`static`
type: string
ip:
description: If `type`==`static`
type: string
netmask:
description: If `type`==`static`
type: string
node1:
$ref: '#/components/schemas/gateway_oob_ip_config_node1'
type:
$ref: '#/components/schemas/ip_type'
use_mgmt_vrf:
default: false
description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
type: boolean
use_mgmt_vrf_for_host_out:
default: false
description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
type: boolean
vlan_id:
$ref: '#/components/schemas/gateway_port_vlan_id_with_variable'
type: object
routing_policy_term_matching_community:
items:
examples:
- '3900062'
type: string
type: array
tunnel_config_node:
additionalProperties: false
description: Only if `provider`==`zscaler-ipsec`, `provider`==`jse-ipsec` or `provider`==`custom-ipsec`
properties:
hosts:
$ref: '#/components/schemas/tunnel_config_node_hosts'
internal_ips:
$ref: '#/components/schemas/tunnel_config_node_internal_ips'
probe_ips:
$ref: '#/components/schemas/strings'
remote_ids:
$ref: '#/components/schemas/tunnel_config_node_remote_ids'
wan_names:
$ref: '#/components/schemas/tunnel_config_node_wan_names'
required:
- hosts
- wan_names
type: object
gateway_mgmt_probe_hosts:
examples:
- - 8.8.8.8
format: ipv4
items:
type: string
type: array
tunnel_config_node_hosts:
items:
description: IP Address of the remote host
type: string
type: array
switch_port_usage_mtu:
anyOf:
- maximum: 9216
minimum: 256
type: integer
- type: string
- type: 'null'
description: Only if `mode`!=`dynamic` media maximum transmission unit (MTU) is the largest data unit that can be forwarded without fragmentation. The default value is 1514.
radius_acct_port:
anyOf:
- maximum: 65545
minimum: 1
type: integer
- type: string
description: Radius Auth Port, value from 1 to 65535, default is 1813
gateway_ip_config_dns_suffix:
description: Except for out-of_band interface (vme/em0/fxp0)
items:
type: string
type: array
switch_port_usage_speed_overwrite:
default: auto
description: 'Port Speed, default is auto to automatically negotiate speed enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
enum:
- 10m
- 100m
- 1g
- 2.5g
- 5g
- 10g
- 25g
- 40g
- 100g
- auto
type: string
dhcpd_config_fixed_bindings:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_fixed_binding'
description: If `type`==`local` or `type6`==`local`. Property key is the MAC Address. Format is `[0-9a-f]{12}` (e.g. "5684dae9ac8b")
examples:
- 5684dae9ac8b:
ip: 192.168.70.35
name: John
type: object
ap_radio_band5:
additionalProperties: false
description: Radio Band AP settings
properties:
allow_rrm_disable:
default: false
type: boolean
ant_gain:
default: 0
maximum: 10
minimum: 0
type:
- integer
- 'null'
antenna_beam_pattern:
$ref: '#/components/schemas/radio_band_antenna_beam_pattern'
antenna_mode:
$ref: '#/components/schemas/radio_band_antenna_mode'
bandwidth:
$ref: '#/components/schemas/dot11_bandwidth5'
channel:
default: null
description: For Device. (primary) channel for the band, 0 means using the Site Setting
examples:
- 100
type:
- integer
- 'null'
channels:
$ref: '#/components/schemas/radio_band_channels'
disabled:
default: false
description: Whether to disable the radio
type: boolean
power:
default: null
description: 'TX power of the radio. For Devices, 0 means auto. -1 / -2 / -3 / …: treated as 0 / -1 / -2 / …'
examples:
- 6
maximum: 25
minimum: 5
type:
- integer
- 'null'
power_max:
default: 17
description: When power=0, max tx power to use, HW-specific values will be used if not set
maximum: 17
minimum: 5
type:
- integer
- 'null'
power_min:
default: 8
description: When power=0, min tx power to use, HW-specific values will be used if not set
maximum: 17
minimum: 5
type:
- integer
- 'null'
preamble:
$ref: '#/components/schemas/radio_band_preamble'
type: object
tunnel_provider_options_prisma:
additionalProperties: false
properties:
service_account_name:
description: For prisma-ipsec, service account name to used for tunnel auto provisioning
examples:
- sa1@1823425211
type: string
type: object
service_policies:
items:
$ref: '#/components/schemas/service_policy'
type: array
gateway_path_preferences_paths:
items:
$ref: '#/components/schemas/gateway_path_preferences_path'
type: array
response_config_history_search_item_radios:
items:
$ref: '#/components/schemas/response_config_history_search_item_radio'
type: array
uniqueItems: true
ap_aeroscout:
additionalProperties: false
description: Aeroscout AP settings
properties:
enabled:
default: false
description: Whether to enable aeroscout config
type: boolean
host:
default: ''
description: Required if enabled, aeroscout server host
examples:
- aero.pvt.net
type:
- string
- 'null'
locate_connected:
default: false
description: Whether to enable the feature to allow wireless clients data received and sent to AES server for location calculation
type: boolean
port:
default: 1144
type:
- integer
- 'null'
type: object
network_internet_access_destination_nat_property:
additionalProperties: false
properties:
internal_ip:
description: The Destination NAT destination IP Address. Must be an IP (i.e. "192.168.70.30") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.30
type: string
name:
examples:
- web server
type: string
port:
description: The Destination NAT destination IP Address. Must be a Port (i.e. "443") or a Variable (i.e. "{{myvar}}")
examples:
- '443'
type: string
wan_name:
description: SRX Only. If not set, we configure the nat policies against all WAN ports for simplicity
examples:
- wan0
type: string
type: object
acl_tag:
additionalProperties: false
description: Resource tags (`type`==`resource` or `type`==`gbp_resource`) can only be used in `dst_tags`
properties:
ether_types:
$ref: '#/components/schemas/acl_tag_ether_types'
gbp_tag:
description: "Required if\n - `type`==`dynamic_gbp` (gbp_tag received from RADIUS)\n - `type`==`gbp_resource`\n - `type`==`static_gbp` (applying gbp tag against matching conditions)"
type: integer
macs:
$ref: '#/components/schemas/acl_tag_macs'
network:
description: "If:\n * `type`==`mac` (optional. default is `any`)\n * `type`==`subnet` (optional. default is `any`)\n * `type`==`network`\n * `type`==`resource` (optional. default is `any`)\n * `type`==`static_gbp` if from matching network (vlan)"
type: string
port_usage:
description: Required if `type`==`port_usage`
type: string
radius_group:
description: "Required if:\n * `type`==`radius_group`\n * `type`==`static_gbp`\nif from matching radius_group"
type: string
specs:
$ref: '#/components/schemas/acl_tag_specs'
subnets:
$ref: '#/components/schemas/acl_tag_subnets'
type:
$ref: '#/components/schemas/acl_tag_type'
required:
- type
type: object
snmp_usm_engine_type:
description: 'enum: `local_engine`, `remote_engine`'
enum:
- local_engine
- remote_engine
type: string
snmp_config_trap_version:
default: v2
description: 'enum: `all`, `v1`, `v2`'
enum:
- all
- v1
- v2
type: string
ap_client_bridge_auth_type:
default: psk
description: 'wpa2-AES/CCMPp is assumed when `type`==`psk`. enum: `open`, `psk`'
enum:
- open
- psk
examples:
- psk
minLength: 1
type: string
ap_radio:
additionalProperties: false
description: Radio AP settings
properties:
allow_rrm_disable:
default: false
type: boolean
ant_gain_24:
description: Antenna gain for 2.4G - for models with external antenna only
examples:
- 4
minimum: 0
type: integer
ant_gain_5:
description: Antenna gain for 5G - for models with external antenna only
examples:
- 5
minimum: 0
type: integer
ant_gain_6:
description: Antenna gain for 6G - for models with external antenna only
examples:
- 5
minimum: 0
type: integer
antenna_mode:
$ref: '#/components/schemas/ap_radio_antenna_mode'
antenna_select:
$ref: '#/components/schemas/antenna_select'
band_24:
$ref: '#/components/schemas/ap_radio_band24'
band_24_usage:
$ref: '#/components/schemas/radio_band_24_usage'
band_5:
$ref: '#/components/schemas/ap_radio_band5'
band_5_on_24_radio:
$ref: '#/components/schemas/ap_radio_band5'
band_6:
$ref: '#/components/schemas/ap_radio_band6'
full_automatic_rrm:
default: false
description: Let RRM control everything, only the `channels` and `ant_gain` will be honored (i.e. disabled/bandwidth/power/band_24_usage are all controlled by RRM)
type: boolean
indoor_use:
default: false
description: To make an outdoor operate indoor. For an outdoor-ap, some channels are disallowed by default, this allows the user to use it as an indoor-ap
type: boolean
rrm_managed:
description: Enable RRM to manage all radio settings (ignores all band_xxx configs)
type: boolean
scanning_enabled:
description: Whether scanning radio is enabled
examples:
- true
type: boolean
type: object
ap_port_config_forwarding:
default: all
description: "enum: \n * `all`: local breakout, All VLANs\n * `limited`: local breakout, only the VLANs configured in `port_vlan_id` and `vlan_ids`\n * `mxtunnel`: central breakout to an Org Mist Edge (requires `mxtunnel_id`)\n * `site_mxedge`: central breakout to a Site Mist Edge (requires `mxtunnel_name`)\n * `wxtunnel`': central breakout to an Org WxTunnel (requires `wxtunnel_id`)"
enum:
- all
- limited
- mxtunnel
- site_mxedge
- wxtunnel
examples:
- all
type: string
snmp_config_client_list_clients:
items:
examples:
- 151.140.101.218/32
type: string
type: array
service_policy_antivirus:
additionalProperties: false
description: For SRX-only
properties:
avprofile_id:
description: org-level AV Profile can be used, this takes precedence over 'profile'
format: uuid
type: string
enabled:
default: false
type: boolean
profile:
description: Default / noftp / httponly / or keys from av_profiles
type: string
type: object
device_type:
description: 'enum: `ap`, `gateway`, `switch`'
enum:
- ap
- gateway
- switch
type: string
gateway_port_vlan_id_with_variable:
description: If WAN interface is on a VLAN. Can be the VLAN ID (i.e. "10") or a Variable (i.e. "{{myvar}}")
oneOf:
- type: string
- maximum: 4094
minimum: 1
type: integer
switch_port_config_overwrite:
additionalProperties: false
description: Switch port config
properties:
description:
type: string
disabled:
default: false
description: Whether the port is disabled
type: boolean
duplex:
$ref: '#/components/schemas/switch_port_usage_duplex_overwrite'
mac_limit:
$ref: '#/components/schemas/switch_port_usage_mac_limit_overwrite'
poe_disabled:
default: false
description: Whether PoE capabilities are disabled for a port
type: boolean
poe_keep_state_when_reboot:
default: false
description: Whether Perpetual PoE is enabled; keeps PoE state across reboots
type: boolean
port_network:
description: Native network/vlan for untagged traffic
type: string
speed:
$ref: '#/components/schemas/switch_port_usage_speed_overwrite'
type: object
ap_mesh_bands:
description: 'List of bands that the mesh should apply to. For relay, the first viable one will be picked. For relay, the first viable one will be picked. enum: `24`, `5`, `6`'
items:
$ref: '#/components/schemas/dot11_band'
type: array
routing_policy_term_action_prepend_as_path:
description: When used as export policy, optional. By default, the local AS will be prepended, to change it. Can be a Variable (e.g. `{{as_path}}`)
items:
examples:
- 65000 400
type: string
type: array
tunnel_config_auto_provision_provider:
description: 'enum: `jse-ipsec`, `zscaler-ipsec`'
enum:
- jse-ipsec
- zscaler-ipsec
type: string
switch_dhcpd_config_fixed_bindings:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_fixed_binding'
description: If `type`==`server` or `type6`==`server`. Property key is the MAC Address. Format is `[0-9a-f]{12}` (e.g. "5684dae9ac8b")
examples:
- 5684dae9ac8b:
ip: 192.168.70.35
name: John
type: object
gateway_mgmt_admin_sshkeys:
description: For SSR only, as direct root access is not allowed
examples:
- - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
items:
type: string
type: array
gateway_port_config_wan_speedtest_mode:
default: auto
description: 'Controls whether Marvis/scheduler can run speedtest on this port. enum: `auto`, `enabled`, `disabled`'
enum:
- auto
- enabled
- disabled
examples:
- auto
type: string
switch_ospf_config:
properties:
areas:
$ref: '#/components/schemas/switch_ospf_config_areas'
enabled:
default: false
description: Enable OSPF on the switch
type: boolean
export_policy:
description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
type: string
import_policy:
description: optional, for basic scenario, `import_policy` can be specified and can be applied to all networks in all areas if not explicitly specified
type: string
reference_bandwidth:
$ref: '#/components/schemas/switch_ospf_config_reference_bandwidth'
idp_config:
additionalProperties: false
properties:
alert_only:
type: boolean
enabled:
default: false
type: boolean
idpprofile_id:
description: org_level IDP Profile can be used, this takes precedence over `profile`
examples:
- 89b9d208-84a4-fa8f-af57-78f92c639cf2
format: uuid
type: string
profile:
default: strict
description: 'enum: `Custom`, `strict` (default), `standard` or keys from idp_profiles'
type: string
type: object
tunnel_config_auth_algo:
description: 'enum: `md5`, `sha1`, `sha2`'
enum:
- md5
- sha1
- sha2
type: string
radsec_proxy_hosts:
description: Default is site.mxedge.radsec.proxy_hosts which must be a superset of all `wlans[*].radsec.proxy_hosts`. When `radsec.proxy_hosts` are not used, tunnel peers (org or site mxedges) are used irrespective of `use_site_mxedge`
items:
examples:
- mxedge1.local
type: string
type: array
snmp_vacm_access_item_prefix_list:
items:
$ref: '#/components/schemas/snmp_vacm_access_item_prefix_list_item'
type: array
switch_port_config_overwrites:
additionalProperties:
$ref: '#/components/schemas/switch_port_config_overwrite'
description: Property key is the port name or range (e.g. "ge-0/0/0-10"). This can be used to override some attributes of the port_usage without having to create a new port_usage.
type: object
radius_auth_server:
additionalProperties: false
description: Authentication Server
properties:
host:
description: IP/ hostname of RADIUS server
examples:
- 1.2.3.4
type: string
keywrap_enabled:
type: boolean
keywrap_format:
$ref: '#/components/schemas/radius_keywrap_format'
keywrap_kek:
examples:
- '1122334455'
type: string
keywrap_mack:
examples:
- '1122334455'
type: string
port:
$ref: '#/components/schemas/radius_auth_port'
require_message_authenticator:
default: false
description: Whether to require Message-Authenticator in requests
type: boolean
secret:
description: Secret of RADIUS server
examples:
- testing123
format: password
type: string
required:
- host
- secret
type: object
extra_routes6:
additionalProperties:
$ref: '#/components/schemas/extra_route6'
description: Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
examples:
- 2a02:1234:420a:10c9::/64:
via: 2a02:1234:200a::100
type: object
tunnel_config_auto_provision_node_wan_names:
description: Optional, only needed if `vars_only`==`false`
items:
examples:
- wan0
type: string
type: array
snmp_config_engine_id:
maxLength: 27
type: string
dns_suffix:
description: Global dns settings. To keep compatibility, dns settings in `ip_config` and `oob_ip_config` will overwrite this setting
items:
type: string
type: array
dns_servers:
description: Global dns settings. To keep compatibility, dns settings in `ip_config` and `oob_ip_config` will overwrite this setting
items:
type: string
type: array
ap_search_wlans:
items:
$ref: '#/components/schemas/ap_search_wlan'
type: array
device_type_with_all:
default: ap
description: ap, switch, gateway, router, all, default is ap. Supports comma-separated values for multiple types (e.g., type=switch,gateway)
type: string
config_switch_local_accounts_user:
additionalProperties: false
properties:
password:
examples:
- Juniper123
format: password
type: string
role:
$ref: '#/components/schemas/config_switch_local_accounts_user_role'
type: object
radius_auth_servers:
items:
$ref: '#/components/schemas/radius_auth_server'
type: array
uniqueItems: true
network_routed_for_networks:
description: For a Network (usually LAN), it can be routable to other networks (e.g. OSPF)
items:
examples:
- pos
type: string
type: array
vlan_id_with_variable:
oneOf:
- type: string
- maximum: 4094
minimum: 1
type: integer
allow_deny:
description: 'enum: `allow`, `deny`'
enum:
- allow
- deny
type: string
idp_profile_overwrite:
additionalProperties: false
properties:
action:
$ref: '#/components/schemas/idp_profile_action'
matching:
$ref: '#/components/schemas/idp_profile_matching'
name:
type: string
type: object
ap_port_config_mac_auth_protocol:
default: pap
description: 'if `enable_mac_auth`==`true`, allows user to select an authentication protocol. enum: `eap-md5`, `eap-peap`, `pap`'
enum:
- eap-md5
- eap-peap
- pap
type: string
tunnel_config_probe_type:
default: icmp
description: 'enum: `http`, `icmp`'
enum:
- http
- icmp
type: string
vrf_extra_route:
additionalProperties: false
properties:
via:
description: Next-hop address
format: ipv4
type: string
type: object
switch_dhcpd_config_dns_servers:
description: If `type`==`server` or `type6`==`server` - optional, if not defined, system one will be used
examples:
- - 8.8.8.8
- 4.4.4.4
- 2001:4860:4860::8888
items:
type: string
type: array
device_search_radius_stat:
additionalProperties: false
properties:
auth_accepts:
description: Number of accepted authentication requests
type: integer
auth_rejects:
description: Number of rejected authentication requests
type: integer
auth_server_status:
$ref: '#/components/schemas/device_search_radius_filter_status'
auth_timeouts:
description: Number of authentication timeouts
type: integer
type: object
switch_iot_port:
additionalProperties: false
description: Switch IOT port configuration
properties:
alarm_class:
$ref: '#/components/schemas/switch_iot_port_alarm_class'
enabled:
default: false
type: boolean
input_src:
$ref: '#/components/schemas/switch_iot_port_input_src'
name:
type: string
type: object
dhcpd_config_servers:
description: If `type`==`relay`
examples:
- - 11.2.3.4
items:
type: string
type: array
ha_cluster_node_enum:
description: 'only for HA. enum: `node0`, `node1`'
enum:
- node0
- node1
type: string
service_policy_skyatp_http_inspection_profile:
description: 'enum: `standard`, `strict`'
enum:
- standard
- strict
type: string
ibeacon_minor:
description: Minor number for iBeacon
examples:
- 1234
maximum: 65535
minimum: 1
type:
- integer
- 'null'
protect_re_allowed_service:
description: 'enum: `icmp`, `ssh`'
enum:
- icmp
- ssh
type: string
switch_iot_config:
additionalProperties:
$ref: '#/components/schemas/switch_iot_port'
description: "Property Key is the IOT port name, e.g.: \n * `IN0` or `IN1` for the FPC0 input port with 5V triggered inputs\n * `OUT1` for the FPC0 output port (can only be triggered by either IN0 or IN1)\n * \"X/IN0`, `X/IN1` and `X/OUT` are used to define IOT ports on VC members"
type: object
switch_ospf_config_areas:
additionalProperties:
$ref: '#/components/schemas/switch_ospf_config_area'
description: Property key is the area name. Defines the OSPF areas configured on the switch.
type: object
ap_zigbee:
additionalProperties: false
description: Zigbee AP settings
properties:
allow_join:
$ref: '#/components/schemas/ap_zigbee_allow_join'
channel:
default: 0
description: Zigbee channel (2.4 GHz). `0` means auto; valid fixed values are 11–26
examples:
- 0
maximum: 26
minimum: 0
type: integer
enabled:
default: false
description: Whether to enable Zigbee on this AP
type: boolean
extended_pan_id:
description: Extended PAN ID in hex string format; only applicable when `pan_id` is also specified
examples:
- 1311768467294899695
type:
- string
- 'null'
pan_id:
description: PAN ID in hex string format; if not specified, assigned automatically
examples:
- '0x1234'
type:
- string
- 'null'
type: object
dhcpd_config_dns_suffix:
description: If `type`==`local` or `type6`==`local` - optional, if not defined, system one will be used
examples:
- - .mist.local
- .mist.com
items:
type: string
type: array
gateway_port_duplex:
default: auto
description: 'enum: `auto`, `full`, `half`'
enum:
- auto
- full
- half
examples:
- full
type: string
ap_search_hostnames:
description: List of hostnames detected for the AP
items:
type: string
type: array
tunnel_config_protocol:
description: 'Only if `provider`==`custom-ipsec`. enum: `gre`, `ipsec`'
enum:
- gre
- ipsec
type: string
snmp_usms:
items:
$ref: '#/components/schemas/snmp_usm'
type: array
count_result:
additionalProperties:
type: string
properties:
count:
type: integer
required:
- count
type: object
tunnel_config_ike_proposals:
description: If `provider`==`custom-ipsec`
items:
$ref: '#/components/schemas/tunnel_config_ike_proposal'
type: array
const_device_type_switch:
description: 'Device Type. enum: `switch`'
enum:
- switch
readOnly: true
type: string
response_config_history_search_item:
additionalProperties: false
properties:
channel_24:
type: integer
channel_5:
type: integer
radio_macs:
$ref: '#/components/schemas/strings'
radios:
$ref: '#/components/schemas/response_config_history_search_item_radios'
secpolicy_violated:
type: boolean
ssids:
$ref: '#/components/schemas/strings'
ssids_24:
$ref: '#/components/schemas/strings'
ssids_5:
$ref: '#/components/schemas/strings'
timestamp:
$ref: '#/components/schemas/timestamp'
version:
type: string
wlans:
$ref: '#/components/schemas/response_config_history_search_item_wlans'
required:
- channel_24
- channel_5
- secpolicy_violated
- timestamp
- version
type: object
service_policy_ssl_proxy:
additionalProperties: false
description: For SRX-only
properties:
ciphers_category:
$ref: '#/components/schemas/ssl_proxy_ciphers_category'
enabled:
default: false
type: boolean
type: object
ap_esl_config:
additionalProperties: false
properties:
cacert:
description: Only if `type`==`imagotag` or `type`==`native`
examples:
- '--BEGIN CERTIFICATE--
MIIDXTCCAkWgAwIBAgIJAL5b1z4f3k2TMA0GCSqGSIb3DQEBCwUAMIGVMQsw
'
type: string
channel:
description: Only if `type`==`imagotag` or `type`==`native`
examples:
- 3
type: integer
enabled:
default: false
description: usb_config is ignored if esl_config enabled
type: boolean
host:
description: Only if `type`==`imagotag` or `type`==`native`
examples:
- 1.1.1.1
type: string
port:
description: Only if `type`==`imagotag` or `type`==`native`
examples:
- 0
type: integer
type:
$ref: '#/components/schemas/ap_esl_type'
verify_cert:
description: Only if `type`==`imagotag` or `type`==`native`
examples:
- true
type: boolean
vlan_id:
default: 1
description: Only if `type`==`solum` or `type`==`hanshow`
type: integer
type: object
switch_port_usages:
additionalProperties:
$ref: '#/components/schemas/switch_port_usage'
description: Property key is the port usage name. Defines the profiles of port configuration configured on the switch
type: object
device_ap:
additionalProperties: false
description: AP
properties:
aeroscout:
$ref: '#/components/schemas/ap_aeroscout'
airista:
$ref: '#/components/schemas/ap_airista'
ble_config:
$ref: '#/components/schemas/ble_config'
centrak:
$ref: '#/components/schemas/ap_centrak'
client_bridge:
$ref: '#/components/schemas/ap_client_bridge'
created_time:
$ref: '#/components/schemas/created_time'
deviceprofile_id:
examples:
- 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
format: uuid
type:
- string
- 'null'
disable_eth1:
default: false
description: Whether to disable eth1 port
type: boolean
disable_eth2:
default: false
description: Whether to disable eth2 port
type: boolean
disable_eth3:
default: false
description: Whether to disable eth3 port
type: boolean
disable_module:
default: false
description: Whether to disable module port
type: boolean
esl_config:
$ref: '#/components/schemas/ap_esl_config'
flow_control:
default: false
description: For some AP models, flow_control can be enabled to address some switch compatibility issue
type: boolean
for_site:
readOnly: true
type: boolean
height:
description: Height, in meters, optional
examples:
- 2.75
format: double
type: number
id:
$ref: '#/components/schemas/id'
image1_url:
type:
- string
- 'null'
image2_url:
type:
- string
- 'null'
image3_url:
type:
- string
- 'null'
iot_config:
$ref: '#/components/schemas/ap_iot'
ip_config:
$ref: '#/components/schemas/ap_ip_config'
lacp_config:
$ref: '#/components/schemas/device_ap_lacp_config'
led:
$ref: '#/components/schemas/ap_led'
locked:
description: Whether this map is considered locked down
type: boolean
mac:
description: Device MAC address
readOnly: true
type: string
map_id:
description: Map where the device belongs to
examples:
- 63eda950-c6da-11e4-a628-60f81dd250cc
format: uuid
type: string
mesh:
$ref: '#/components/schemas/ap_mesh'
model:
description: Device Model
readOnly: true
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
name:
examples:
- conference room
type: string
notes:
description: Any notes about this AP
examples:
- slightly off center
type: string
ntp_servers:
$ref: '#/components/schemas/strings'
org_id:
$ref: '#/components/schemas/org_id'
orientation:
description: Orientation, 0-359, in degrees, up is 0, right is 90.
examples:
- 45
maximum: 359
minimum: 0
type: integer
poe_passthrough:
default: false
description: Whether to enable power out through module port (for APH) or eth1 (for APL/BT11)
type: boolean
port_config:
additionalProperties:
$ref: '#/components/schemas/ap_port_config'
description: eth0 is not allowed here. Property key is the interface(s) name (e.g. `eth1` or `eth1,eth2`). If spcified, this takes predecence over switch_config (switch_config requires user to configure all vlans manually, which is error-prone. thus deprecated)
type: object
pwr_config:
$ref: '#/components/schemas/ap_pwr_config'
radio_config:
$ref: '#/components/schemas/ap_radio'
serial:
description: Device Serial
readOnly: true
type: string
site_id:
$ref: '#/components/schemas/site_id'
type:
$ref: '#/components/schemas/const_device_type_ap'
uplink_port_config:
$ref: '#/components/schemas/ap_uplink_port_config'
usb_config:
$ref: '#/components/schemas/ap_usb'
vars:
$ref: '#/components/schemas/vars'
x:
description: X in pixel
examples:
- 53.5
format: double
type: number
y:
description: Y in pixel
examples:
- 173.1
format: double
type: number
zigbee_config:
$ref: '#/components/schemas/ap_zigbee'
required:
- type
type: object
sw_routing_policy_term_matching_protocol:
items:
$ref: '#/components/schemas/sw_routing_policy_term_matching_protocol_enum'
type: array
dhcpd_config_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_option'
description: If `type`==`local` or `type6`==`local`. Property key is the DHCP option number
type: object
networks:
items:
$ref: '#/components/schemas/network'
type: array
switch_oob_ip_config:
additionalProperties: false
description: "Switch OOB IP Config:\n - If HA configuration: key parameter will be nodeX (eg: node1)\n - If there are 2 routing engines, re1 mgmt IP has to be set separately (if desired): key parameter = `re1`"
properties:
gateway:
type: string
ip:
type: string
netmask:
description: Used only if `subnet` is not specified in `networks`
type: string
network:
description: Optional, the network to be used for mgmt
type: string
type:
$ref: '#/components/schemas/ip_type'
use_mgmt_vrf:
default: false
description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
type: boolean
use_mgmt_vrf_for_host_out:
default: false
description: For host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
type: boolean
type: object
gateway_port_config_reth_idx:
anyOf:
- type: integer
- type: string
description: For SRX only and if HA Mode. `-1` means it will be managed by the device. Use `>= 0` values to manage it manually. Ensure no conflicting values are assigned across all ports.
dhcp_snooping:
additionalProperties: false
properties:
all_networks:
type: boolean
enable_arp_spoof_check:
description: Enable for dynamic ARP inspection check
type: boolean
enable_ip_source_guard:
description: Enable for check for forging source IP address
type: boolean
enabled:
type: boolean
networks:
$ref: '#/components/schemas/dhcp_snooping_networks'
type: object
ble_config_power_mode:
default: default
description: 'enum: `custom`, `default`'
enum:
- custom
- default
examples:
- custom
type: string
remote_syslog_server_protocol:
default: udp
description: 'enum: `tcp`, `udp`'
enum:
- tcp
- udp
type: string
idp_profile_matching_severity:
items:
$ref: '#/components/schemas/idp_profile_matching_severity_value'
type: array
const_device_type_gateway:
description: 'Device Type. enum: `gateway`'
enum:
- gateway
readOnly: true
type: string
org_id:
examples:
- a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
format: uuid
readOnly: true
type: string
routing_policy_term_matching_prefix:
description: zero or more criteria/filter can be specified to match the term, all criteria have to be met
items:
examples:
- 192.168.0.0/16-30
type: string
type: array
aggregate_route:
additionalProperties: false
properties:
discard:
default: false
type: boolean
metric:
maximum: 4294967295
minimum: 0
type:
- integer
- 'null'
preference:
maximum: 4294967295
minimum: 0
type:
- integer
- 'null'
type: object
remote_syslog_servers:
examples:
- - facility: config
host: syslogd.internal
port: 514
protocol: udp
severity: info
tag: ''
items:
$ref: '#/components/schemas/remote_syslog_server'
type: array
snmp_config_client_lists:
items:
$ref: '#/components/schemas/snmp_config_client_list'
type: array
gw_routing_policy_term_matching_vpn_path:
description: overlay-facing criteria (used for bgp_config where via=vpn). ordered-
items:
type: string
type: array
radsec:
additionalProperties: false
description: RadSec settings
properties:
coa_enabled:
default: false
type: boolean
enabled:
type: boolean
idle_timeout:
$ref: '#/components/schemas/radsec_idle_timeout'
mxcluster_ids:
$ref: '#/components/schemas/radsec_mxcluster_ids'
proxy_hosts:
$ref: '#/components/schemas/radsec_proxy_hosts'
server_name:
description: Name of the server to verify (against the cacerts in Org Setting). Only if not Mist Edge.
examples:
- radsec.abc.com
type: string
servers:
$ref: '#/components/schemas/radsec_servers'
use_mxedge:
description: use mxedge(s) as RadSec Proxy
type: boolean
use_site_mxedge:
default: false
description: To use Site mxedges when this WLAN does not use mxtunnel
type: boolean
type: object
radio_band_24_usage:
description: 'enum: `24`, `5`, `6`, `auto`'
enum:
- '24'
- '5'
- '6'
- auto
type: string
tunnel_config_ike_dh_group:
default: '14'
description: "enum:\n * 1\n * 2 (1024-bit)\n * 5\n * 14 (default, 2048-bit)\n * 15 (3072-bit)\n * 16 (4096-bit)\n * 19 (256-bit ECP)\n * 20 (384-bit ECP)\n * 21 (521-bit ECP)\n * 24 (2048-bit ECP)"
enum:
- '1'
- '14'
- '15'
- '16'
- '19'
- '2'
- '20'
- '21'
- '24'
- '5'
type: string
ap_search:
additionalProperties: false
properties:
band_24_bandwidth:
description: Bandwidth of band_24
type: string
band_24_channel:
description: Channel of band_24
type: integer
band_24_power:
type: integer
band_5_bandwidth:
description: Bandwidth of band_5
type: string
band_5_channel:
description: Channel of band_5
type: integer
band_5_power:
type: integer
band_6_bandwidth:
type: string
band_6_channel:
description: Channel of band_6
type: integer
band_6_power:
type: integer
eth0_port_speed:
description: Port speed of eth0
type: integer
ext_ip:
type: string
hostname:
$ref: '#/components/schemas/ap_search_hostnames'
inactive_wired_vlans:
$ref: '#/components/schemas/ap_search_inactive_wired_vlans'
ip:
description: IP Address
type: string
last_hostname:
type: string
lldp_mgmt_addr:
description: LLDP management ip address
type: string
lldp_port_desc:
type: string
lldp_port_id:
description: LLDP port id
type: string
lldp_power_allocated:
type: integer
lldp_power_draw:
type: integer
lldp_system_desc:
description: LLDP system description
type: string
lldp_system_name:
description: LLDP system name
type: string
mac:
description: Device model
type: string
model:
type: string
mxedge_id:
description: Mist Edge id, if AP is connecting to a Mist Edge
type: string
mxedge_ids:
description: Comma separated list of Mist Edge ids, if AP is connecting to a Mist Edge
type: string
mxtunnel_status:
description: MxTunnel status
type: string
org_id:
$ref: '#/components/schemas/org_id'
power_constrained:
type: boolean
power_opmode:
type: string
site_id:
$ref: '#/components/schemas/site_id'
sku:
type: string
timestamp:
$ref: '#/components/schemas/timestamp'
uptime:
type: integer
version:
description: Version
type: string
wlans:
$ref: '#/components/schemas/ap_search_wlans'
required:
- power_constrained
- power_opmode
- mxtunnel_status
- wlans
type: object
gateway_path_preferences_path:
additionalProperties: false
properties:
cost:
type: integer
disabled:
description: For SSR Only. `true`, if this specific path is undesired
type: boolean
gateway_ip:
description: Only if `type`==`local`, if a different gateway is desired
type: string
internet_access:
description: Only if `type`==`vpn`, if this vpn path can be used for internet
type: boolean
name:
description: "Required when \n * `type`==`vpn`: the name of the VPN Path to use \n * `type`==`wan`: the name of the WAN interface to use"
type: string
networks:
$ref: '#/components/schemas/gateway_path_preferences_path_networks'
target_ips:
$ref: '#/components/schemas/gateway_path_preferences_path_target_ips'
type:
$ref: '#/components/schemas/gateway_path_type'
wan_name:
description: Optional if `type`==`vpn`
examples:
- wan0
type: string
required:
- type
type: object
ap_search_wlan:
additionalProperties: false
properties:
id:
format: uuid
type: string
ssid:
type: string
type: object
ap_import_json:
items:
$ref: '#/components/schemas/device_ap'
type: array
service_policy_skyatp_iot_device_policy:
additionalProperties: false
properties:
enabled:
type: boolean
type: object
switch_port_usage_duplex_overwrite:
default: auto
description: 'Link connection mode. enum: `auto`, `full`, `half`'
enum:
- auto
- full
- half
type: string
switch_port_usage_storm_control:
additionalProperties: false
description: Switch storm control. Only if `mode`!=`dynamic`
properties:
disable_port:
default: false
description: Whether to disable the port when storm control is triggered
type: boolean
no_broadcast:
default: false
description: Whether to disable storm control on broadcast traffic
type: boolean
no_multicast:
default: false
description: Whether to disable storm control on multicast traffic
type: boolean
no_registered_multicast:
default: false
description: Whether to disable storm control on registered multicast traffic
type: boolean
no_unknown_unicast:
default: false
description: Whether to disable storm control on unknown unicast traffic
type: boolean
percentage:
default: 80
description: Bandwidth-percentage, configures the storm control level as a percentage of the available bandwidth
maximum: 100
minimum: 0
type: integer
type: object
service_policy_skyatp_dns_tunnel_detection_profile:
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
ap_search_inactive_wired_vlans:
items:
type: integer
type: array
ap_port_config_port_auth:
default: none
description: 'When doing port auth. enum: `dot1x`, `none`'
enum:
- dot1x
- none
examples:
- none
type: string
switch_vrf_instances:
additionalProperties:
$ref: '#/components/schemas/switch_vrf_instance'
description: Property key is the network name
examples:
- guest:
extra_routes:
0.0.0.0/0:
via: 192.168.31.1
networks:
- guest
type: object
snmp_vacm:
additionalProperties: false
properties:
access:
$ref: '#/components/schemas/snmp_vacm_access'
security_to_group:
$ref: '#/components/schemas/snmp_vacm_security_to_group'
type: object
gw_routing_policies:
additionalProperties:
$ref: '#/components/schemas/gw_routing_policy'
description: Property key is the routing policy name
type: object
radio_band_antenna_mode:
default: default
description: 'enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`'
enum:
- 1x1
- 2x2
- 3x3
- 4x4
- default
examples:
- default
type: string
device_gateway:
additionalProperties: false
description: Device gateway
properties:
additional_config_cmds:
$ref: '#/components/schemas/additional_config_cmds'
bgp_config:
additionalProperties:
$ref: '#/components/schemas/bgp_config'
type: object
created_time:
$ref: '#/components/schemas/created_time'
deviceprofile_id:
format: uuid
readOnly: true
type: string
dhcpd_config:
$ref: '#/components/schemas/dhcpd_config'
dns_servers:
$ref: '#/components/schemas/dns_servers'
dns_suffix:
$ref: '#/components/schemas/dns_suffix'
extra_routes:
$ref: '#/components/schemas/gateway_extra_routes'
extra_routes6:
$ref: '#/components/schemas/gateway_extra_routes6'
for_site:
readOnly: true
type: boolean
gateway_mgmt:
$ref: '#/components/schemas/gateway_mgmt'
id:
$ref: '#/components/schemas/id'
idp_profiles:
$ref: '#/components/schemas/gateway_idp_profiles'
image1_url:
type:
- string
- 'null'
image2_url:
type:
- string
- 'null'
image3_url:
type:
- string
- 'null'
ip_configs:
$ref: '#/components/schemas/gateway_ip_configs'
mac:
description: Device MAC address
readOnly: true
type: string
managed:
deprecated: true
description: Whether the device is managed by Mist. Deprecated in favour of mist_configured.
type: boolean
map_id:
description: Map where the device belongs to
examples:
- 63eda950-c6da-11e4-a628-60f81dd250cc
format: uuid
type: string
mist_configured:
description: whether the device can be configured by Mist or not. This deprecates `managed` for adopted devices.
type: boolean
model:
description: Device Model
readOnly: true
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
msp_id:
$ref: '#/components/schemas/msp_id'
name:
type: string
networks:
$ref: '#/components/schemas/networks'
notes:
type: string
ntp_servers:
$ref: '#/components/schemas/strings'
oob_ip_config:
$ref: '#/components/schemas/gateway_oob_ip_config'
org_id:
$ref: '#/components/schemas/org_id'
path_preferences:
additionalProperties:
$ref: '#/components/schemas/gateway_path_preferences'
description: Property key is the path name
type: object
port_config:
additionalProperties:
$ref: '#/components/schemas/gateway_port_config'
description: Property key is the port name or range (e.g. "ge-0/0/0-10")
type: object
port_mirroring:
$ref: '#/components/schemas/gateway_port_mirroring'
router_id:
description: Auto assigned if not set
examples:
- 10.2.1.10
type: string
routing_policies:
$ref: '#/components/schemas/gw_routing_policies'
serial:
description: Device Serial
readOnly: true
type: string
service_policies:
$ref: '#/components/schemas/service_policies'
site_id:
$ref: '#/components/schemas/site_id'
tunnel_configs:
additionalProperties:
$ref: '#/components/schemas/tunnel_config'
description: Property key is the tunnel name
type: object
tunnel_provider_options:
$ref: '#/components/schemas/tunnel_provider_options'
type:
$ref: '#/components/schemas/const_device_type_gateway'
url_filtering_deny_msg:
default: Access to this URL Category has been blocked
description: When a service policy denies a app_category, what message to show in user's browser
examples:
- Access to this URL Category has been blocked
type: string
vars:
$ref: '#/components/schemas/vars'
vrf_config:
$ref: '#/components/schemas/vrf_config'
vrf_instances:
$ref: '#/components/schemas/gateway_vrf_instances'
x:
description: X in pixel
examples:
- 53.5
format: double
type: number
y:
description: Y in pixel
examples:
- 173.1
format: double
type: number
required:
- type
type: object
gw_routing_policy_term_action_add_target_vrfs:
description: For SSR, hub decides how VRF routes are leaked on spoke
items:
type: string
type: array
ibeacon_major:
description: Major number for iBeacon
examples:
- 1234
maximum: 65535
minimum: 1
type:
- integer
- 'null'
protect_re_customs:
items:
$ref: '#/components/schemas/protect_re_custom'
type: array
dhcpd_config_vendor_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_vendor_option'
description: "If `type`==`local` or `type6`==`local`. Property key is :, with\n * enterprise number: 1-65535 (https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)\n * sub option code: 1-255, sub-option code"
type: object
network_internet_access_static_nat_property:
additionalProperties: false
properties:
internal_ip:
description: The Static NAT destination IP Address. Must be an IP Address (i.e. "192.168.70.3") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.3
type: string
name:
examples:
- pos_station-1
type: string
wan_name:
description: SRX Only. If not set, we configure the nat policies against all WAN ports for simplicity. Can be a Variable (i.e. "{{myvar}}")
examples:
- wan0
type: string
type: object
tacacs_auth_servers:
items:
$ref: '#/components/schemas/tacacs_auth_server'
type: array
gateway_port_reth_nodes:
description: SSR only - supporting vlan-based redundancy (matching the size of `networks`)
examples:
- - node0
- node1
items:
type: string
type: array
binary_stream:
additionalProperties: false
properties:
file:
contentMediaType: application/octet-stream
description: File to upload
type: string
required:
- file
type: object
tunnel_config_node_internal_ips:
description: Only if `provider`==`zscaler-gre`, `provider`==`jse-ipsec`, `provider`==`custom-ipsec` or `provider`==`custom-gre`
items:
type: string
type: array
site_device_last_config_count_distinct:
default: mac
description: 'enum: `mac`, `name`, `site_id`, `version`'
enum:
- mac
- name
- site_id
- version
type: string
switch_port_usage_reauth_interval:
anyOf:
- default: 3600
maximum: 65535
minimum: 10
type: integer
- type: string
description: 'Only if `mode`!=`dynamic` and `port_auth`=`dot1x` reauthentication interval range (min: 10, max: 65535, default: 3600). Set to 0 to disable reauthentication (no-reauthentication).'
response_config_history_search_item_radio:
additionalProperties: false
properties:
band:
type: string
channel:
type: integer
required:
- band
- channel
type: object
gateway_port_wan_arp_policer:
default: default
description: 'Only when `wan_type`==`broadband`. enum: `default`, `max`, `recommended`'
enum:
- default
- max
- recommended
type: string
snmp_vacm_access_item_type:
description: 'enum: `context_prefix`, `default_context_prefix`'
enum:
- context_prefix
- default_context_prefix
type: string
remote_syslog_archive:
additionalProperties: false
properties:
files:
$ref: '#/components/schemas/remote_syslog_archive_files'
size:
examples:
- 5m
type: string
type: object
junos_port_config_duplex:
default: auto
description: 'enum: `auto`, `full`, `half`'
enum:
- auto
- full
- half
type: string
ble_config_beacon_rate_mode:
default: default
description: 'enum: `custom`, `default`'
enum:
- custom
- default
examples:
- custom
type: string
gateway_idp_profiles:
additionalProperties:
$ref: '#/components/schemas/idp_profile'
description: Property key is the profile name
type: object
switch_bgp_config_neighbor:
additionalProperties: false
properties:
export_policy:
description: Export policy must match one of the policy names defined in the `routing_policies` property.
type: string
hold_time:
$ref: '#/components/schemas/switch_bgp_config_hold_time'
import_policy:
description: Import policy must match one of the policy names defined in the `routing_policies` property.
type: string
multihop_ttl:
maximum: 255
minimum: 1
type: integer
neighbor_as:
$ref: '#/components/schemas/bgp_as'
description: Autonomous System (AS) number of the BGP neighbor. For internal BGP, this must match `local_as`. For external BGP, this must differ from `local_as`.
required:
- neighbor_as
type: object
gateway_port_vpn_path:
additionalProperties: false
properties:
bfd_profile:
$ref: '#/components/schemas/gateway_port_vpn_path_bfd_profile'
bfd_use_tunnel_mode:
default: false
description: Only if the VPN `type`==`hub_spoke`. Whether to use tunnel mode. SSR only
type: boolean
preference:
description: Only if the VPN `type`==`hub_spoke`. For a given VPN, when `path_selection.strategy`==`simple`, the preference for a path (lower is preferred)
type: integer
role:
$ref: '#/components/schemas/gateway_port_vpn_path_role'
traffic_shaping:
$ref: '#/components/schemas/gateway_traffic_shaping'
type: object
radsec_idle_timeout:
anyOf:
- default: 60
type: integer
- type: string
description: Radsec Idle Timeout in seconds. Default is 60
gateway_port_mirroring_ingress_port_ids:
items:
examples:
- ge-0/0/3
type: string
type: array
remote_syslog_severity:
default: any
description: 'enum: `alert`, `any`, `critical`, `emergency`, `error`, `info`, `notice`, `warning`'
enum:
- alert
- any
- critical
- emergency
- error
- info
- notice
- warning
type: string
gateway_mgmt_auto_signature_update:
additionalProperties: false
properties:
day_of_week:
$ref: '#/components/schemas/day_of_week'
enable:
default: true
type: boolean
time_of_day:
description: Optional, Mist will decide the timing
type: string
type: object
radius_coa_port:
anyOf:
- maximum: 65545
minimum: 1
type: integer
- type: string
description: Radius CoA Port, value from 1 to 65535, default is 3799
ap_iot_output:
additionalProperties: false
description: IoT output AP settings
properties:
enabled:
default: false
description: Whether to enable a pin
type: boolean
name:
description: Optional; descriptive pin name
examples:
- motion
type: string
output:
description: Whether the pin is configured as an output. DO and A1-A4 can be repurposed by changing
examples:
- true
type: boolean
pullup:
$ref: '#/components/schemas/ap_iot_pullup'
value:
description: Output pin signal level, default 0
examples:
- 0
type: integer
type: object
timestamp:
description: Epoch (seconds)
format: double
readOnly: true
type: number
service_policy_skyatp_dns_tunnel_detection:
additionalProperties: false
properties:
enabled:
type: boolean
profile:
$ref: '#/components/schemas/service_policy_skyatp_dns_tunnel_detection_profile'
type: object
routing_policy_local_preference:
anyOf:
- type: string
- maximum: 4294967295
minimum: 1
type: integer
description: Optional, for an import policy, local_preference can be changed, value in range 1-4294967294. Can be a Variable (e.g. `{{bgp_as}}`)
switch_port_local_usage_mac_auth_protocol:
default: eap-md5
description: 'Only if `enable_mac_auth` ==`true`. This type is ignored if mist_nac is enabled. enum: `eap-md5`, `eap-peap`, `pap`'
enum:
- eap-md5
- eap-peap
- pap
type: string
acl_policy_action:
additionalProperties: false
properties:
action:
$ref: '#/components/schemas/allow_deny'
dst_tag:
examples:
- corp
type: string
required:
- dst_tag
type: object
network_vpn_access_config_other_vrfs:
description: By default, the routes are only readvertised toward the same vrf on spoke. To allow it to be leaked to other vrfs
items:
examples:
- iot
type: string
type: array
device_type_gateway:
description: 'Device Type. enum: `gateway`'
enum:
- gateway
type: string
switch_mist_nac:
additionalProperties: false
description: Enable mist_nac to use RadSec
properties:
enabled:
type: boolean
network:
type: string
type: object
response_http401:
additionalProperties: false
properties:
detail:
examples:
- Authentication credentials were not provided.
type: string
type: object
evpn_config_role:
description: 'enum: `access`, `border`, `collapsed-core`, `core`, `distribution`, `esilag-access`, `none`'
enum:
- access
- border
- collapsed-core
- core
- distribution
- esilag-access
- none
readOnly: true
type: string
wan_extra_routes6:
additionalProperties: false
properties:
via:
format: ipv6
type: string
type: object
snmpv3_config_target_param_security_model:
description: 'enum: `usm`, `v1`, `v2c`'
enum:
- usm
- v1
- v2c
type: string
snmp_usm_user_authentication_type:
description: 'sha224, sha256, sha384, sha512 are supported in 21.1 and newer release. enum: `authentication-md5`, `authentication-none`, `authentication-sha`, `authentication-sha224`, `authentication-sha256`, `authentication-sha384`, `authentication-sha512`'
enum:
- authentication-md5
- authentication-none
- authentication-sha
- authentication-sha224
- authentication-sha256
- authentication-sha384
- authentication-sha512
type: string
acl_tag_subnets:
description: "If \n- `type`==`subnet` \n- `type`==`resource` (optional. default is `any`)\n- `type`==`static_gbp` if from matching subnet"
items:
type: string
type: array
config_devices:
items:
$ref: '#/components/schemas/config_device'
type: array
radius_auth_port:
anyOf:
- maximum: 65545
minimum: 1
type: integer
- type: string
description: Radius Auth Port, value from 1 to 65535, default is 1812
additional_config_cmds:
description: 'additional CLI commands to append to the generated Junos config. **Note**: no check is done'
items:
description: JUNOS "set" command to add to the generated configuration
examples:
- set snmp community public
type: string
type: array
gateway_path_strategy:
default: ordered
description: 'enum: `ecmp`, `ordered`, `weighted`'
enum:
- ecmp
- ordered
- weighted
type: string
switch_dhcpd_config_property:
additionalProperties: false
description: the Property key is the network name. In case of DHCP relay, it's common for many networks to use the same dhcp relay, comma-separated network names can be used here (e.g. "net1,net2")
properties:
dns_servers:
$ref: '#/components/schemas/switch_dhcpd_config_dns_servers'
dns_suffix:
$ref: '#/components/schemas/switch_dhcpd_config_dns_suffix'
fixed_bindings:
$ref: '#/components/schemas/switch_dhcpd_config_fixed_bindings'
gateway:
description: If `type`==`server` - optional, `ip` will be used if not provided
examples:
- 192.168.70.1
type: string
ip_end:
description: If `type`==`server`
examples:
- 192.168.70.200
type: string
ip_end6:
description: If `type6`==`server`
examples:
- 2607:f8b0:4005:808::ff
type: string
ip_start:
description: If `type`==`server`
examples:
- 192.168.70.100
type: string
ip_start6:
description: If `type6`==`server`
examples:
- 2607:f8b0:4005:808::2
type: string
lease_time:
default: 86400
description: In seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]
maximum: 604800
minimum: 3600
type: integer
options:
$ref: '#/components/schemas/switch_dhcpd_config_options'
server_id_override:
default: false
description: "`server_id_override`==`true` means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, \nshould overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address."
type: boolean
servers:
$ref: '#/components/schemas/dhcpd_config_servers'
servers6:
$ref: '#/components/schemas/dhcpd_config_servers6'
type:
$ref: '#/components/schemas/switch_dhcpd_config_type'
type6:
$ref: '#/components/schemas/switch_dhcpd_config_type6'
vendor_encapsulated:
$ref: '#/components/schemas/switch_dhcpd_config_vendor_options'
type: object
snmp_config:
additionalProperties: false
properties:
client_list:
$ref: '#/components/schemas/snmp_config_client_lists'
contact:
examples:
- cns@juniper.net
type: string
description:
examples:
- Juniper QFX Series Switch - 1K_5LA
type: string
enabled:
default: true
type: boolean
engine_id:
$ref: '#/components/schemas/snmp_config_engine_id'
engine_id_type:
$ref: '#/components/schemas/snmp_config_engine_id_type'
location:
examples:
- Las Vegas, NV
type: string
name:
examples:
- TGH-1K-QFX10K
type: string
network:
default: default
type: string
trap_groups:
$ref: '#/components/schemas/snmp_config_trap_groups'
v2c_config:
$ref: '#/components/schemas/snmp_config_v2c_configs'
v3_config:
$ref: '#/components/schemas/snmpv3_config'
views:
$ref: '#/components/schemas/snmp_config_views'
type: object
remote_syslog_archive_files:
anyOf:
- type: string
- type: integer
examples:
- 20
gateway_traffic_shaping:
additionalProperties: false
properties:
class_percentages:
$ref: '#/components/schemas/gateway_traffic_shaping_class_percentages'
enabled:
default: false
type: boolean
max_tx_kbps:
description: Interface Transmit Cap in kbps
type: integer
type: object
switch_search:
additionalProperties: false
properties:
clustered:
type: boolean
evpn_missing_links:
type: boolean
evpntopo_id:
type: string
ext_ip:
type: string
hostname:
$ref: '#/components/schemas/strings'
ip:
type: string
last_config_status:
type: string
last_hostname:
type: string
last_trouble_code:
type: string
last_trouble_timestamp:
$ref: '#/components/schemas/timestamp'
mac:
type: string
managed:
deprecated: true
type: boolean
mist_configured:
description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
type: boolean
model:
type: string
num_members:
type: integer
org_id:
$ref: '#/components/schemas/org_id'
radius_stats:
$ref: '#/components/schemas/device_search_radius_stats'
role:
type: string
site_id:
$ref: '#/components/schemas/site_id'
time_drifted:
type: boolean
timestamp:
$ref: '#/components/schemas/timestamp'
type:
$ref: '#/components/schemas/device_type_switch'
uptime:
type: integer
version:
type: string
required:
- type
type: object
switch_radius_config:
additionalProperties: false
description: Junos Radius config
properties:
acct_immediate_update:
type: boolean
acct_interim_interval:
default: 0
description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from RADIUS Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled
maximum: 65535
minimum: 0
type: integer
acct_servers:
$ref: '#/components/schemas/radius_acct_servers'
auth_server_selection:
$ref: '#/components/schemas/switch_radius_config_auth_server_selection'
auth_servers:
$ref: '#/components/schemas/radius_auth_servers'
auth_servers_retries:
default: 3
description: Radius auth session retries
type: integer
auth_servers_timeout:
default: 5
description: Radius auth session timeout
type: integer
coa_enabled:
default: false
type: boolean
coa_port:
$ref: '#/components/schemas/radius_coa_port'
fast_dot1x_timers:
default: false
type: boolean
network:
description: Use `network`or `source_ip`. Which network the RADIUS server resides, if there's static IP for this network, we'd use it as source-ip
type: string
source_ip:
description: Use `network`or `source_ip`
type: string
type: object
zscaler_sub_locations:
description: '`sub-locations` can be used for specific uses cases to define different configuration based on the user network'
items:
$ref: '#/components/schemas/tunnel_provider_options_zscaler_sub_location'
type: array
snmpv3_config_target_address_item:
additionalProperties: false
properties:
address:
examples:
- 10.11.0.2
type: string
address_mask:
examples:
- 255.255.255.0
type: string
port:
default: '161'
type:
- string
- 'null'
tag_list:
description: Refer to notify tag, can be multiple with blank
type: string
target_address_name:
examples:
- target_address_name
type: string
target_parameters:
description: Refer to notify target parameters name
type: string
type: object
switch_ospf_config_reference_bandwidth:
anyOf:
- type: integer
- type: string
description: Reference bandwidth. Integer(100000) or String (10g)
examples:
- 100000
device_switch:
additionalProperties: false
description: 'You can configure `port_usages` and `networks` settings at the device level, but most of the time it''s better use the Site Setting to achieve better consistency and be able to re-use the same settings across switches entries defined here will "replace" those defined in Site Setting/Network Template
In addition it is possible to use the `port_config_overwrite` to overwrite some attributes of the port_usage without having to create a new port_usage.'
properties:
acl_policies:
$ref: '#/components/schemas/acl_policies'
acl_tags:
$ref: '#/components/schemas/acl_tags'
additional_config_cmds:
$ref: '#/components/schemas/additional_config_cmds'
aggregate_routes:
$ref: '#/components/schemas/aggregate_routes'
aggregate_routes6:
$ref: '#/components/schemas/aggregate_routes6'
bgp_config:
additionalProperties:
$ref: '#/components/schemas/switch_bgp_config'
type: object
created_time:
$ref: '#/components/schemas/created_time'
default_port_usage:
default: default
description: 'Port usage to assign to switch ports without any port usage assigned. Default: `default` to preserve default behavior'
type: string
deviceprofile_id:
format: uuid
readOnly: true
type: string
dhcp_snooping:
$ref: '#/components/schemas/dhcp_snooping'
dhcpd_config:
$ref: '#/components/schemas/switch_dhcpd_config'
disable_auto_config:
default: false
description: This disables the default behavior of a cloud-ready switch/gateway being managed/configured by Mist. Setting this to `true` means you want to disable the default behavior and do not want the device to be Mist-managed.
type: boolean
dns_servers:
$ref: '#/components/schemas/dns_servers'
dns_suffix:
$ref: '#/components/schemas/dns_suffix'
evpn_config:
$ref: '#/components/schemas/evpn_config'
extra_routes:
$ref: '#/components/schemas/extra_routes'
extra_routes6:
$ref: '#/components/schemas/extra_routes6'
id:
$ref: '#/components/schemas/id'
image1_url:
type:
- string
- 'null'
image2_url:
type:
- string
- 'null'
image3_url:
type:
- string
- 'null'
iot_config:
$ref: '#/components/schemas/switch_iot_config'
ip_config:
$ref: '#/components/schemas/junos_ip_config'
local_port_config:
$ref: '#/components/schemas/local_port_config'
mac:
description: Device MAC address
readOnly: true
type: string
managed:
default: false
deprecated: true
description: An adopted switch/gateway will not be managed/configured by Mist by default. Setting this parameter to `true` enables the adopted switch/gateway to be managed/configured by Mist. Deprecated in favour of mist_configured, which is more intuitive and can be used for both adopted and claimed devices.
type: boolean
map_id:
description: Map where the device belongs to
examples:
- 63eda950-c6da-11e4-a628-60f81dd250cc
format: uuid
type: string
mist_configured:
description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
type: boolean
mist_nac:
$ref: '#/components/schemas/switch_mist_nac'
model:
description: Device Model
readOnly: true
type: string
modified_time:
$ref: '#/components/schemas/modified_time'
name:
type: string
networks:
$ref: '#/components/schemas/switch_networks'
notes:
type: string
ntp_servers:
$ref: '#/components/schemas/ntp_servers'
oob_ip_config:
$ref: '#/components/schemas/switch_oob_ip_config'
org_id:
$ref: '#/components/schemas/org_id'
ospf_areas:
$ref: '#/components/schemas/ospf_areas'
ospf_config:
$ref: '#/components/schemas/switch_ospf_config'
other_ip_configs:
additionalProperties:
$ref: '#/components/schemas/junos_other_ip_config'
description: Property key is the network name. Defines the additional IP Addresses configured on the device.
type: object
port_config:
$ref: '#/components/schemas/wired_port_config'
port_config_overwrite:
$ref: '#/components/schemas/switch_port_config_overwrites'
port_mirroring:
$ref: '#/components/schemas/switch_port_mirroring'
port_usages:
$ref: '#/components/schemas/switch_port_usages'
radius_config:
$ref: '#/components/schemas/switch_radius_config'
remote_syslog:
$ref: '#/components/schemas/remote_syslog'
role:
type: string
router_id:
description: Used for OSPF / BGP / EVPN
examples:
- 10.2.1.10
type: string
routing_policies:
$ref: '#/components/schemas/sw_routing_policies'
serial:
description: Device Serial
readOnly: true
type: string
site_id:
$ref: '#/components/schemas/site_id'
snmp_config:
$ref: '#/components/schemas/snmp_config'
stp_config:
$ref: '#/components/schemas/switch_stp_config'
switch_mgmt:
$ref: '#/components/schemas/switch_mgmt'
type:
$ref: '#/components/schemas/const_device_type_switch'
use_router_id_as_source_ip:
default: false
description: Whether to use it for snmp / syslog / tacplus / radius
type: boolean
vars:
$ref: '#/components/schemas/vars'
virtual_chassis:
$ref: '#/components/schemas/switch_virtual_chassis'
vrf_config:
$ref: '#/components/schemas/vrf_config'
vrf_instances:
$ref: '#/components/schemas/switch_vrf_instances'
vrrp_config:
$ref: '#/components/schemas/vrrp_config'
x:
description: X in pixel
examples:
- 53.5
format: double
type: number
y:
description: Y in pixel
examples:
- 173.1
format: double
type: number
required:
- type
type: object
network_vpn_access_static_nat_property:
additionalProperties: false
properties:
internal_ip:
description: The Static NAT destination IP Address. Must be an IP Address (i.e. "192.168.70.3") or a Variable (i.e. "{{myvar}}")
examples:
- 192.168.70.3
type: string
name:
examples:
- pos_station-1
type: string
type: object
ospf_areas:
additionalProperties:
$ref: '#/components/schemas/ospf_area'
description: Junos OSPF areas. Property key is the OSPF Area (Area should be a number (0-255) / IP address)
type: object
network_vpn_access_config:
additionalProperties: false
properties:
advertised_subnet:
description: If `routed`==`true`, whether to advertise an aggregated subnet toward HUB this is useful when there are multiple networks on SPOKE's side
examples:
- 172.16.0.0/24
type: string
allow_ping:
description: Whether to allow ping from vpn into this routed network
type: boolean
destination_nat:
$ref: '#/components/schemas/network_vpn_access_destination_nat'
nat_pool:
description: If `routed`==`false` (usually at Spoke), but some hosts needs to be reachable from Hub, a subnet is required to create and advertise the route to Hub
examples:
- 172.16.0.0/26
type: string
no_readvertise_to_lan_bgp:
default: false
description: toward LAN-side BGP peers
type: boolean
no_readvertise_to_lan_ospf:
default: false
description: toward LAN-side OSPF peers
type: boolean
no_readvertise_to_overlay:
description: toward overlay, how HUB should deal with routes it received from Spokes
type: boolean
other_vrfs:
$ref: '#/components/schemas/network_vpn_access_config_other_vrfs'
routed:
description: Whether this network is routable
type: boolean
source_nat:
$ref: '#/components/schemas/network_source_nat'
static_nat:
$ref: '#/components/schemas/network_vpn_access_static_nat'
summarized_subnet:
description: toward overlay, how HUB should deal with routes it received from Spokes
examples:
- 172.16.0.0/16
type: string
summarized_subnet_to_lan_bgp:
description: toward LAN-side BGP peers
examples:
- 172.16.0.0/16
type: string
summarized_subnet_to_lan_ospf:
description: toward LAN-side OSPF peers
examples:
- 172.16.0.0/16
type: string
type: object
snmp_vacm_security_to_group_content:
items:
$ref: '#/components/schemas/snmp_vacm_security_to_group_content_item'
type: array
snmp_usm:
additionalProperties: false
properties:
engine_type:
$ref: '#/components/schemas/snmp_usm_engine_type'
remote_engine_id:
description: Required only if `engine_type`==`remote_engine`
examples:
- 00:00:00:0b:00:00:70:10:6f:08:b6:3f
type: string
users:
$ref: '#/components/schemas/snmp_usm_users'
type: object
dot11_bandwidth24:
default: 20
description: 'channel width for the 2.4GHz band. enum: `0`(disabled, response only), `20`, `40`'
enum:
- 0
- 20
- 40
examples:
- 20
type: integer
evpn_config:
additionalProperties: false
description: EVPN Junos settings
properties:
enabled:
readOnly: true
type: boolean
role:
$ref: '#/components/schemas/evpn_config_role'
readOnly: true
type: object
tunnel_config_auto_provision:
additionalProperties: false
description: Auto Provisioning configuration for the tunne. This takes precedence over the `primary` and `secondary` nodes.
properties:
enabled:
description: Enable auto provisioning for the tunnel. If enabled, the `primary` and `secondary` nodes will be ignored.
type: boolean
latlng:
$ref: '#/components/schemas/tunnel_config_auto_provision_lat_lng'
primary:
$ref: '#/components/schemas/tunnel_config_auto_provision_node'
provider:
$ref: '#/components/schemas/tunnel_config_auto_provision_provider'
region:
description: API override for POP selection in the case user wants to override the auto discovery of remote network location and force the tunnel to use the specified peer location.
type: string
secondary:
$ref: '#/components/schemas/tunnel_config_auto_provision_node'
service_connection:
description: if `provider`==`prisma-ipsec`. By default, we'll use the location of the site to determine the optimal Remote Network location, optionally, service_connection can be considered, then we'll also consider this along with the site location. Define service_connection if the traffic is to be routed to a specific service connection. This field takes a service connection name that is configured in the Prisma cloud, Prisma Access Setup -> Service Connections.
examples:
- Juniper-Lab-SC-1
type: string
required:
- provider
type: object
vrf_extra_routes6:
additionalProperties:
$ref: '#/components/schemas/vrf_extra_route6'
description: Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
examples:
- 2a02:1234:420a:10c9::/64:
via: 2a02:1234:200a::100
type: object
snmp_usm_users:
items:
$ref: '#/components/schemas/snmp_usm_user'
type: array
ap_radio_antenna_mode:
default: default
description: 'enum: `1x1`, `2x2`, `3x3`, `4x4`, `default`'
enum:
- 1x1
- 2x2
- 3x3
- 4x4
- default
type: string
switch_port_usage_dynamic_rules:
description: Only if `mode`==`dynamic`
items:
$ref: '#/components/schemas/switch_port_usage_dynamic_rule'
type: array
junos_port_config_speed:
default: auto
description: 'enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
enum:
- 10m
- 100m
- 1g
- 2.5g
- 5g
- 10g
- 25g
- 40g
- 100g
- auto
type: string
idp_profile_matching_attack_name:
items:
examples:
- HTTP:INVALID:HDR-FIELD
type: string
type: array
snmp_config_client_list:
additionalProperties: false
properties:
client_list_name:
examples:
- clist-1
type: string
clients:
$ref: '#/components/schemas/snmp_config_client_list_clients'
type: object
network_multicast:
additionalProperties: false
description: Whether to enable multicast support (only PIM-sparse mode is supported)
properties:
disable_igmp:
default: false
description: If the network will only be the source of the multicast traffic, IGMP can be disabled
type: boolean
enabled:
default: false
type: boolean
groups:
$ref: '#/components/schemas/network_multicast_groups'
type: object
junos_ip_config:
additionalProperties: false
description: Junos IP Config
properties:
dns:
$ref: '#/components/schemas/strings'
dns_suffix:
$ref: '#/components/schemas/strings'
gateway:
type: string
ip:
type: string
netmask:
description: Used only if `subnet` is not specified in `networks`
type: string
network:
description: Network where this mgmt IP reside, this will be used as default network for outbound-ssh, dns, ntp, dns, tacplus, radius, syslog, snmp
type: string
type:
$ref: '#/components/schemas/ip_type'
type: object
switch_port_usage_mac_limit:
anyOf:
- default: 0
maximum: 16383
minimum: 0
type: integer
- type: string
description: Only if `mode`!=`dynamic`, max number of mac addresses, default is 0 for unlimited, otherwise range is 1 to 16383 (upper bound constrained by platform)
switch_port_usage_speed:
default: auto
description: 'Only if `mode`!=`dynamic`, Port speed, default is auto to automatically negotiate speed enum: `100m`, `10m`, `1g`, `2.5g`, `5g`, `10g`, `25g`, `40g`, `100g`,`auto`'
enum:
- 10m
- 100m
- 1g
- 2.5g
- 5g
- 10g
- 25g
- 40g
- 100g
- auto
type: string
app_probing_custom_apps:
items:
$ref: '#/components/schemas/app_probing_custom_app'
type: array
switch_dhcpd_config:
additionalProperties:
$ref: '#/components/schemas/switch_dhcpd_config_property'
properties:
enabled:
default: false
description: If set to `true`, enable the DHCP server
type: boolean
type: object
switch_virtual_chassis_member_vc_role:
description: 'Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. enum: `backup`, `linecard`, `master`'
enum:
- backup
- linecard
- master
type: string
sw_routing_policies:
additionalProperties:
$ref: '#/components/schemas/sw_routing_policy'
description: Property key is the routing policy name
type: object
gateway_oob_ip_config_node1:
additionalProperties: false
description: For HA Cluster, node1 can have different IP Config
properties:
gateway:
description: If `type`==`static`
type: string
ip:
type: string
netmask:
description: Used only if `subnet` is not specified in `networks`
type: string
type:
$ref: '#/components/schemas/ip_type'
use_mgmt_vrf:
default: false
description: If supported on the platform. If enabled, DNS will be using this routing-instance, too
type: boolean
use_mgmt_vrf_for_host_out:
default: false
description: Whether to use `mgmt_junos` for host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired
type: boolean
vlan_id:
$ref: '#/components/schemas/gateway_port_vlan_id_with_variable'
type: object
gw_routing_policy_term_matching_vpn_path_sla:
additionalProperties: false
properties:
max_jitter:
type:
- integer
- 'null'
max_latency:
examples:
- 1500
type:
- integer
- 'null'
max_loss:
examples:
- 30
type:
- integer
- 'null'
type: object
switch_dhcpd_config_type:
description: 'enum: `none`, `relay` (DHCP Relay), `server` (DHCP Server)'
enum:
- none
- relay
- server
type: string
switch_radius_config_auth_server_selection:
default: ordered
description: 'enum: `ordered`, `unordered`'
enum:
- ordered
- unordered
type: string
gateway_path_preferences_path_target_ips:
description: If `type`==`local`, if destination IP is to be replaced
items:
type: string
type: array
acl_tag_ether_types:
default:
- any
description: ARP / IPv6. Default is `any`
items:
type: string
type: array
snmp_config_v2c_configs:
items:
$ref: '#/components/schemas/snmp_config_v2c_config'
type: array
snmpv3_config_notify:
items:
$ref: '#/components/schemas/snmpv3_config_notify_items'
type: array
ap_ip_config:
additionalProperties: false
description: IP AP settings
properties:
dns:
$ref: '#/components/schemas/ap_ip_config_dns'
dns_suffix:
$ref: '#/components/schemas/ap_ip_config_dns_suffix'
gateway:
description: Required if `type`==`static`
examples:
- 10.2.1.254
format: ipv4
type: string
gateway6:
examples:
- 2607:f8b0:4005:808::1
format: ipv6
type: string
ip:
description: Required if `type`==`static`
examples:
- 10.2.1.1
format: ipv4
type: string
ip6:
examples:
- 2607:f8b0:4005:808::2004
format: ipv6
type: string
mtu:
examples:
- 0
type: integer
netmask:
description: Required if `type`==`static`
examples:
- 255.255.255.0
type: string
netmask6:
examples:
- /32
type: string
type:
$ref: '#/components/schemas/ip_type'
type6:
$ref: '#/components/schemas/ip_type6'
vlan_id:
default: 1
description: Management VLAN id, default is 1 (untagged)
examples:
- 1
type: integer
type: object
vrf_config:
additionalProperties: false
properties:
enabled:
description: Whether to enable VRF (when supported on the device)
type: boolean
type: object
radius_keywrap_format:
description: 'enum: `ascii`, `hex`'
enum:
- ascii
- hex
type: string
ap_mesh:
additionalProperties: false
description: Mesh AP settings
properties:
bands:
$ref: '#/components/schemas/ap_mesh_bands'
enabled:
default: false
description: Whether mesh is enabled on this AP
type: boolean
group:
description: Mesh group, base AP(s) will only allow remote AP(s) in the same mesh group to join, 1-9, optional
examples:
- 1
maximum: 9
minimum: 1
type:
- integer
- 'null'
role:
$ref: '#/components/schemas/ap_mesh_role'
use_wpa3_on_5:
default: false
description: Whether to use WPA3 on the 5 GHz band for mesh links
type: boolean
type: object
service_policy_skyatp_http_inspection:
additionalProperties: false
properties:
enabled:
type: boolean
profile:
$ref: '#/components/schemas/service_policy_skyatp_http_inspection_profile'
type: object
remote_syslog_console:
additionalProperties: false
properties:
contents:
$ref: '#/components/schemas/remote_syslog_contents'
type: object
gateway_search:
additionalProperties: false
properties:
clustered:
type: boolean
evpn_missing_links:
type: boolean
evpntopo_id:
type: string
ext_ip:
type: string
hostname:
$ref: '#/components/schemas/strings'
ip:
type: string
last_config_status:
type: string
last_hostname:
type: string
last_trouble_code:
type: string
last_trouble_timestamp:
type: integer
mac:
type: string
managed:
deprecated: true
type: boolean
mist_configured:
description: whether the device can be configured by Mist or not. This deprecates `managed` (for adopted device) and `disable_auto_config` for claimed device)
type: boolean
model:
type: string
node:
type: string
node0_mac:
type: string
node1_mac:
type: string
num_members:
type: integer
org_id:
$ref: '#/components/schemas/org_id'
role:
type: string
site_id:
$ref: '#/components/schemas/site_id'
t128agent_version:
type: string
time_drifted:
type: boolean
timestamp:
$ref: '#/components/schemas/timestamp'
type:
$ref: '#/components/schemas/device_type_gateway'
uptime:
type: integer
version:
type: string
required:
- type
type: object
acl_tag_specs:
description: If `type`==`resource`, `type`==`radius_group`, `type`==`port_usage` or `type`==`gbp_resource`. Empty means unrestricted, i.e. any
items:
$ref: '#/components/schemas/acl_tag_spec'
type: array
bgp_local_as:
anyOf:
- type: string
- maximum: 4294967295
minimum: 1
type: integer
description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. BGP AS, value in range 1-4294967295
examples:
- 65000
wlan_mist_nac:
additionalProperties: false
properties:
acct_interim_interval:
default: 0
description: How frequently should interim accounting be reported, 60-65535. default is 0 (use one specified in Access-Accept request from Server). Very frequent messages can affect the performance of the radius server, 600 and up is recommended when enabled.
examples:
- 60
maximum: 65535
minimum: 0
type: integer
auth_servers_retries:
default: 2
description: Radius auth session retries. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "retries" are set to value of `auth_servers_timeout`. "max-requests" is also set when setting `auth_servers_retries` is set to default value to 3.
examples:
- 3
maximum: 10
minimum: 1
type: integer
auth_servers_timeout:
default: 5
description: Radius auth session timeout. Following fast timers are set if `fast_dot1x_timers` knob is enabled. "quite-period" and "transmit-period" are set to half the value of `auth_servers_timeout`. "supplicant-timeout" is also set when setting `auth_servers_timeout` is set to default value of 10.
examples:
- 5
maximum: 30
minimum: 1
type: integer
coa_enabled:
default: false
description: Allows a RADIUS server to dynamically modify the authorization status of a user session.
type: boolean
coa_port:
description: the communication port used for “Change of Authorization” (CoA) messages
examples:
- 3799
maximum: 65535
minimum: 1
type: integer
enabled:
default: false
description: "When enabled:\n * `auth_servers` is ignored\n * `acct_servers` is ignored\n * `auth_servers_*` are ignored\n * `coa_servers` is ignored\n * `radsec` is ignored\n * `coa_enabled` is assumed"
type: boolean
fast_dot1x_timers:
default: false
description: If set to true, sets default fast-timers with values calculated from `auth_servers_timeout` and `auth_server_retries`.
type: boolean
network:
description: Which network the mist nac server resides in
examples:
- default
type:
- string
- 'null'
source_ip:
description: In case there is a static IP for this network, we can specify it using source ip
examples:
- 1.2.3.4
type:
- string
- 'null'
type: object
ap_usb_type:
description: 'usb config type. enum: `hanshow`, `imagotag`, `solum`'
enum:
- hanshow
- imagotag
- solum
examples:
- imagotag
type: string
extra_route6:
additionalProperties: false
properties:
discard:
default: false
description: This takes precedence
type: boolean
metric:
examples:
- null
maximum: 2147483647
minimum: 0
type:
- integer
- 'null'
next_qualified:
additionalProperties:
$ref: '#/components/schemas/extra_route6_next_qualified_properties'
examples:
- 2a02:1234:200a::100:
metric: null
preference: 40
type: object
no_resolve:
default: false
type: boolean
preference:
examples:
- 30
maximum: 2147483647
minimum: 0
type:
- integer
- 'null'
via:
$ref: '#/components/schemas/next_hop_via'
type: object
dhcpd_config:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_property'
properties:
enabled:
default: true
description: If set to `false`, disable the DHCP server
type: boolean
type: object
bgp_config_networks:
description: Optional if `via`==`lan`. List of networks where we expect BGP neighbor to connect to/from
items:
type: string
type: array
snmp_config_trap_group:
additionalProperties: false
properties:
categories:
$ref: '#/components/schemas/snmp_config_trap_group_categories'
group_name:
description: Categories list can refer to https://www.juniper.net/documentation/software/topics/task/configuration/snmp_trap-groups-configuring-junos-nm.html
examples:
- profiler
type: string
targets:
$ref: '#/components/schemas/snmp_config_trap_group_targets'
version:
$ref: '#/components/schemas/snmp_config_trap_version'
type: object
bgp_config_neighbors:
additionalProperties: false
properties:
disabled:
default: false
description: If true, the BGP session to this neighbor will be administratively disabled/shutdown
type: boolean
export_policy:
type: string
hold_time:
default: 90
maximum: 65535
minimum: 0
type: integer
import_policy:
type: string
multihop_ttl:
description: Assuming BGP neighbor is directly connected
maximum: 255
minimum: 0
type: integer
neighbor_as:
$ref: '#/components/schemas/bgp_as'
tunnel_via:
$ref: '#/components/schemas/tunnel_via'
required:
- neighbor_as
type: object
snmpv3_config_target_params:
items:
$ref: '#/components/schemas/snmpv3_config_target_param'
type: array
switch_bgp_config:
additionalProperties: false
properties:
auth_key:
type: string
bfd_minimum_interval:
description: Minimum interval in milliseconds for BFD hello packets. A neighbor is considered failed when the device stops receiving replies after the specified interval. Value must be between 1 and 255000.
maximum: 255000
minimum: 1
type: integer
export_policy:
description: Export policy must match one of the policy names defined in the `routing_policies` property.
type: string
hold_time:
$ref: '#/components/schemas/switch_bgp_config_hold_time'
import_policy:
description: Import policy must match one of the policy names defined in the `routing_policies` property.
type: string
local_as:
$ref: '#/components/schemas/bgp_as'
neighbors:
$ref: '#/components/schemas/switch_bgp_config_neighbors'
networks:
$ref: '#/components/schemas/switch_bgp_config_networks'
type:
$ref: '#/components/schemas/switch_bgp_config_type'
required:
- type
- local_as
type: object
network_tenants:
additionalProperties:
$ref: '#/components/schemas/network_tenant'
description: Property key must be the user/tenant name (i.e. "printer-1") or a Variable (i.e. "{{myvar}}")
type: object
tunnel_config_enc_algo:
default: aes256
description: 'enum: `3des`, `aes128`, `aes256`, `aes_gcm128`, `aes_gcm256`'
enum:
- 3des
- aes128
- aes256
- aes_gcm128
- aes_gcm256
type:
- string
- 'null'
gw_routing_policy_term_matching_protocol_enum:
description: 'enum: `aggregate`, `bgp`, `direct`, `ospf`, `static` (SRX Only)'
enum:
- aggregate
- bgp
- direct
- ospf
- static
type: string
gateway_extra_routes:
additionalProperties:
$ref: '#/components/schemas/gateway_extra_route'
description: Property key is the destination CIDR (e.g. "10.0.0.0/8"), the destination Network name or a variable (e.g. "{{myvar}}")
type: object
tunnel_config_provider:
description: 'Only if `auto_provision.enabled`==`false`. enum: `custom-ipsec`, `custom-gre`, `jse-ipsec`, `prisma-ipsec`, `zscaler-gre`, `zscaler-ipsec`'
enum:
- custom-ipsec
- custom-gre
- jse-ipsec
- prisma-ipsec
- zscaler-gre
- zscaler-ipsec
type: string
service_policy_appqoe:
additionalProperties: false
description: SRX only
properties:
enabled:
default: false
type: boolean
type: object
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
radsec_mxcluster_ids:
description: To use Org mxedges when this WLAN does not use mxtunnel, specify their mxcluster_ids. Org mxedge(s) identified by mxcluster_ids
items:
examples:
- 572586b7-f97b-a22b-526c-8b97a3f609c4
format: uuid
type: string
type: array
tacacs:
additionalProperties: false
properties:
acct_servers:
$ref: '#/components/schemas/tacacs_acct_servers'
default_role:
$ref: '#/components/schemas/tacacs_default_role'
enabled:
type: boolean
network:
description: Which network the TACACS server resides
type: string
tacplus_servers:
$ref: '#/components/schemas/tacacs_auth_servers'
type: object
snmpv3_config_notify_filter_item_contents:
items:
$ref: '#/components/schemas/snmpv3_config_notify_filter_item_content'
type: array
bgp_config:
additionalProperties: false
description: BFD is enabled when either bfd_minimum_interval or bfd_multiplier is configured
properties:
auth_key:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`
type: string
bfd_minimum_interval:
default: 350
description: "Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_multiplier is configured alone. Default:\n * 1000 if `type`==`external`\n * 350 `type`==`internal`"
maximum: 255000
minimum: 1
type:
- integer
- 'null'
bfd_multiplier:
default: 3
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`, when bfd_minimum_interval_is_configured alone
maximum: 255
minimum: 1
type:
- integer
- 'null'
disable_bfd:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. BFD provides faster path failure detection and is enabled by default
type: boolean
export:
type: string
export_policy:
description: Default export policies if no per-neighbor policies defined
type: string
extended_v4_nexthop:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, either inet/net6 unicast depending on neighbor IP family (v4 or v6). For v6 neighbors, to exchange v4 nexthop, which allows dual-stack support, enable this
type: boolean
graceful_restart_time:
default: 0
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. `0` means disable
maximum: 4095
minimum: 0
type: integer
hold_time:
default: 90
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default is 90.
maximum: 65535
minimum: 0
type: integer
import:
type: string
import_policy:
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. Default import policies if no per-neighbor policies defined
type: string
local_as:
$ref: '#/components/schemas/bgp_local_as'
neighbor_as:
$ref: '#/components/schemas/bgp_as'
neighbors:
additionalProperties:
$ref: '#/components/schemas/bgp_config_neighbors'
description: Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If per-neighbor as is desired. Property key is the neighbor address
type: object
networks:
$ref: '#/components/schemas/bgp_config_networks'
no_private_as:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. If true, we will not advertise private ASNs (AS 64512-65534) to this neighbor
type: boolean
no_readvertise_to_overlay:
default: false
description: Optional if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. By default, we'll re-advertise all learned BGP routers toward overlay
type: boolean
tunnel_name:
description: Optional if `via`==`tunnel`
type: string
type:
$ref: '#/components/schemas/bgp_config_type'
via:
$ref: '#/components/schemas/bgp_config_via'
vpn_name:
description: Optional if `via`==`vpn`
type: string
wan_name:
description: Optional if `via`==`wan`
type: string
required:
- via
type: object
network_multicast_group:
additionalProperties: false
properties:
rp_ip:
description: RP (rendezvous point) IP Address
type: string
type: object
switch_bgp_config_hold_time_integer:
maximum: 65535
minimum: 3
type: integer
service_policy_ewf_rule:
additionalProperties: false
properties:
alert_only:
type: boolean
block_message:
examples:
- Access to this URL Category has been blocked
type: string
enabled:
default: false
type: boolean
profile:
$ref: '#/components/schemas/service_policy_ewf_rule_profile'
type: object
gateway_path_preferences:
additionalProperties: false
properties:
paths:
$ref: '#/components/schemas/gateway_path_preferences_paths'
strategy:
$ref: '#/components/schemas/gateway_path_strategy'
type: object
switch_port_usage_mode:
description: '`mode`==`dynamic` must only be used if the port usage name is `dynamic`. enum: `access`, `dynamic`, `inet`, `trunk`'
enum:
- access
- dynamic
- inet
- trunk
type: string
radsec_server:
additionalProperties: false
properties:
host:
examples:
- 1.1.1.1
type: string
port:
examples:
- 1812
maximum: 65535
minimum: 1
type: integer
type: object
vrf_extra_route6:
additionalProperties: false
properties:
via:
description: Next-hop address
format: ipv6
type: string
type: object
switch_port_usage_duplex:
default: auto
description: 'Only if `mode`!=`dynamic`. Link connection mode. enum: `auto`, `full`, `half`'
enum:
- auto
- full
- half
type: string
ntp_servers:
description: List of NTP servers specific to this device. By default, those in Site Settings will be used
items:
type: string
type: array
switch_bgp_config_neighbors:
additionalProperties:
$ref: '#/components/schemas/switch_bgp_config_neighbor'
description: Property key is the BGP Neighbor IP Address.
type: object
response_http404:
additionalProperties: false
properties:
id:
type: string
type: object
snmp_config_trap_groups:
items:
$ref: '#/components/schemas/snmp_config_trap_group'
type: array
switch_virtual_chassis:
additionalProperties: false
description: Required for preprovisioned Virtual Chassis
properties:
members:
$ref: '#/components/schemas/switch_virtual_chassis_members'
preprovisioned:
default: false
description: To configure whether the VC is preprovisioned or nonprovisioned
type: boolean
type: object
dhcpd_config_vendor_option_type:
description: 'enum: `boolean`, `hex`, `int16`, `int32`, `ip`, `string`, `uint16`, `uint32`'
enum:
- boolean
- hex
- int16
- int32
- ip
- string
- uint16
- uint32
type: string
ospf_areas_network:
additionalProperties: false
description: Property key is the network name. Networks to participate in an OSPF area
properties:
auth_keys:
additionalProperties:
type: string
description: Required if `auth_type`==`md5`. Property key is the key number
examples:
- '1': auth-key-1
type: object
auth_password:
description: Required if `auth_type`==`password`, the password, max length is 8
examples:
- simple
type: string
auth_type:
$ref: '#/components/schemas/ospf_area_network_auth_type'
bfd_minimum_interval:
examples:
- 500
maximum: 255000
minimum: 1
type: integer
dead_interval:
examples:
- 40
maximum: 65535
minimum: 1
type: integer
export_policy:
examples:
- export_policy
type: string
hello_interval:
maximum: 255
minimum: 1
type: integer
import_policy:
examples:
- import_policy
type: string
interface_type:
$ref: '#/components/schemas/ospf_area_network_interface_type'
metric:
examples:
- 10000
maximum: 65535
minimum: 1
type:
- integer
- 'null'
no_readvertise_to_overlay:
default: false
description: By default, we'll re-advertise all learned OSPF routes toward overlay
type: boolean
passive:
default: false
description: Whether to send OSPF-Hello
type: boolean
type: object
device_type_default_ap:
default: ap
description: 'enum: `ap`, `gateway`, `switch`'
enum:
- ap
- gateway
- switch
type: string
dhcpd_config_vendor_option:
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/dhcpd_config_vendor_option_type'
value:
type: string
type: object
switch_dhcpd_config_vendor_options:
additionalProperties:
$ref: '#/components/schemas/dhcpd_config_vendor_option'
description: "If `type`==`server` or `type6`==`server`. Property key is :, with\n * enterprise number: 1-65535 (https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)\n * sub option code: 1-255, sub-option code'"
type: object
poe_priority:
description: 'PoE priority. enum: `low`, `high`'
enum:
- low
- high
type: string
gateway_wan_type6:
default: autoconf
description: 'enum: `autoconf`, `dhcp`, `static`'
enum:
- autoconf
- dhcp
- static
type: string
extra_route6_next_qualified_properties:
additionalProperties: false
properties:
metric:
type:
- integer
- 'null'
preference:
type:
- integer
- 'null'
type: object
sw_routing_policy:
additionalProperties: false
properties:
terms:
$ref: '#/components/schemas/sw_routing_policy_terms'
type: object
network:
description: Networks are usually subnets that have cross-site significance. `networks`in Org Settings will got merged into `networks`in Site Setting. For gateways, they can be used to define Service Routes.
properties:
created_time:
$ref: '#/components/schemas/created_time'
disallow_mist_services:
default: false
description: Whether to disallow Mist Devices in the network
type: boolean
gateway:
examples:
- 192.168.70.1
format: ipv4
type: string
gateway6:
examples:
- fdad:b0bc:f29e::1
format: ipv6
type: string
id:
$ref: '#/components/schemas/id'
internal_access:
$ref: '#/components/schemas/network_internal_access'
internet_access:
$ref: '#/components/schemas/network_internet_access'
isolation:
description: Whether to allow clients in the network to talk to each other
type: boolean
modified_time:
$ref: '#/components/schemas/modified_time'
multicast:
$ref: '#/components/schemas/network_multicast'
name:
type: string
org_id:
$ref: '#/components/schemas/org_id'
routed_for_networks:
$ref: '#/components/schemas/network_routed_for_networks'
subnet:
examples:
- 192.168.70.0/24
type: string
subnet6:
examples:
- fdad:b0bc:f29e::/32
type: string
tenants:
$ref: '#/components/schemas/network_tenants'
vlan_id:
$ref: '#/components/schemas/vlan_id_with_variable'
vpn_access:
$ref: '#/components/schemas/network_vpn_access'
required:
- name
type: object
bgp_config_type:
description: 'Required if `via`==`lan`, `via`==`tunnel` or `via`==`wan`. enum: `external`, `internal`'
enum:
- external
- internal
minLength: 1
type: string
search_site_devices_sort:
default: timestamp
description: 'enum: `mac`, `model`, `sku`, `timestamp`'
enum:
- mac
- model
- sku
- timestamp
type: string
tunnel_config_dh_group:
default: '14'
description: "Only if `provider`==`custom-ipsec`. enum:\n * 1\n * 2 (1024-bit)\n * 5\n * 14 (default, 2048-bit)\n * 15 (3072-bit)\n * 16 (4096-bit)\n * 19 (256-bit ECP)\n * 20 (384-bit ECP)\n * 21 (521-bit ECP)\n * 24 (2048-bit ECP)"
enum:
- '1'
- '14'
- '15'
- '16'
- '19'
- '2'
- '20'
- '21'
- '24'
- '5'
type: string
idp_profile_matching_severity_value:
description: 'enum: `critical`, `info`, `major`, `minor`'
enum:
- critical
- info
- major
- minor
examples:
- major
type: string
gateway_port_config_wan_networks:
description: Only if `usage`==`wan`. If some networks are connected to this WAN port, it can be added here so policies can be defined
items:
type: string
type: array
service_policy_skyatp_dns_dga_detection:
additionalProperties: false
properties:
enabled:
type: boolean
profile:
$ref: '#/components/schemas/service_policy_skyatp_dns_dga_detection_profile'
type: object
parameters:
device_type:
description: 'Type of device. enum: `ap`, `gateway`, `switch`'
in: query
name: type
schema:
$ref: '#/components/schemas/device_type_default_ap'
page:
in: query
name: page
schema:
default: 1
minimum: 1
type: integer
start:
description: Start time (epoch timestamp in seconds, or relative string like "-1d", "-1w")
in: query
name: start
schema:
type: string
partial_filter_mac_device:
description: Partial / full Device MAC address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `001122*` and `*1122*` match `001122334455`). Suffix-only wildcards (e.g. `*4455`) are not supported
in: query
name: mac
schema:
examples:
- aabbccddeeff
- aabbcc*
- '*bbcc*'
type: string
partial_filter_ext_ip:
description: Partial / full Device external ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `1.2.3.*` and `*.2.3.*` match `1.2.3.4`). Suffix-only wildcards (e.g. `*.2.3.4`) are not supported
in: query
name: ext_ip
schema:
examples:
- 1.2.3.4
- 1.2.3.*
- '*2.3.*'
type: string
partial_filter_lldp_system_name:
description: When `type`==`ap`, LLDP system name. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-switch*` and `*switch*` match `my-switch-01`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
in: query
name: lldp_system_name
schema:
type: string
duration:
description: Duration like 7d, 2w
in: query
name: duration
schema:
default: 1d
examples:
- 10m
type: string
end:
description: End time (epoch timestamp in seconds, or relative string like "-1d", "-2h", "now")
in: query
name: end
schema:
type: string
limit:
in: query
name: limit
schema:
default: 100
minimum: 0
type: integer
partial_filter_lldp_port_id:
description: When `type`==`ap`, LLDP port id. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `ge-0/0/*` and `*-0/0/*` match `ge-0/0/30`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
in: query
name: lldp_port_id
schema:
type: string
device_id:
in: path
name: device_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
device_event_type:
description: See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)
in: query
name: type
schema:
type: string
search_after:
description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed.
in: query
name: search_after
schema:
type: string
partial_filter_lldp_system_desc:
description: When `type`==`ap`, LLDP system description. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Juniper Networks*` and `*Networks*` match `Juniper Networks, Inc.`). Suffix-only wildcards (e.g. `*switch-01`) are not supported
in: query
name: lldp_system_desc
schema:
type: string
partial_filter_ip_device:
description: Partial / full Device IP Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported
in: query
name: ip
schema:
examples:
- 10.100.10.54
- 10.100.10.*
- '*100.10.*'
type: string
partial_filter_hostname_device:
description: Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported
in: query
name: hostname
schema:
examples:
- my-london-1
- my-london*
- '*london*'
type: string
site_id:
in: path
name: site_id
required: true
schema:
examples:
- 000000ab-00ab-00ab-00ab-0000000000ab
format: uuid
type: string
name:
in: query
name: name
schema:
type: string
sort:
description: On which field the list should be sorted, -prefix represents DESC order
in: query
name: sort
schema:
default: timestamp
examples:
- -site_id
type: string
partial_filter_model:
description: Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported
in: query
name: model
schema:
examples:
- AP43
- AP4*
- '*P4*'
type: string
examples:
ConfigsHistorySearchExample:
value:
end: 1531862583
limit: 10
results:
- channel_24: 11
channel_5: 100
radio_macs:
- 5c5b352e000a
- 5c5b352e000b
- 5c5b352e000c
radios:
- band: '24'
channel: 11
- band: '5'
channel: 100
secpolicy_violated: false
ssids:
- test24
- test5
ssids_24:
- test24
ssids_5:
- test5
timestamp: 1531855856.643369
version: apfw-0.2.14754-cersei-75c8
wlans:
- auth: psk
bands:
- '24'
id: be22bba7-8e22-e1cf-5185-b880816fe2cf
ssid: test24
vlan_ids:
- '1'
- auth: psk
bands:
- '5'
id: f8c18724-4118-3487-811a-f98964988604
ssid: test5
vlan_ids:
- '1'
start: 1531776183
total: 1
CountExample:
value:
distinct: string
end: 0
limit: 0
results:
- count: 0
property: string
start: 0
total: 0
HTTP400Example:
value:
detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
HTTP401Example:
value:
detail: Authentication credentials were not provided.
Deviceswitch:
value:
additional_config_cmds:
- set snmp community public
created_time: 0
deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
disable_auto_config: false
id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
image1_url: https://url/to/image.png
ip_config:
dns:
- 8.8.8.8
- 4.4.4.4
dns_suffix:
- .mist.local
- .mist.com
gateway: 10.2.1.254
ip: 10.2.1.1
netmask: 255.255.255.0
network: default
type: static
modified_time: 0
name: corp
notes: slightly off center
ntp_servers:
- pool.ntp.org
- time.google.com
org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
other_ip_configs:
guest:
ip: 10.3.3.1
netmask: 255.255.255.0
type: static
port_config:
ge-0/0/0:
aggregated: true
description: to dist-sw-01
usage: uplink
ge-0/0/1:
dynamic_usage: dynamic
usage: default
ge-0/0/8-16,ge-1/0/0-47:
usage: ap
radius_config:
acct_interim_interval: 0
acct_servers:
- host: 1.2.3.4
port: 1812
secret: testing123
auth_servers:
- host: 1.2.3.4
port: 1812
secret: testing123
- host: radius.internal
port: 1812
secret: testing123
auth_servers_retries: 3
auth_servers_timeout: 5
role: access
site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
type: switch
vars:
RADIUS_IP1: 172.31.2.5
RADIUS_SECRET: 11s64632d
DevicesSearchAp:
value:
end: 0
limit: 0
next: string
results:
- hostname:
- AP41-STB-3E5299-WH-2001
- AP41-STB-3E5299-WH-50
- AP41-STB-3E5299
- 5c5b353e5299
ip: 10.2.16.205
lldp_mgmt_addr: 10.2.10.139
lldp_port_desc: GigabitEthernet1/0/1
lldp_port_id: Gi1/0/1
lldp_system_desc: 'Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)
Technical Support: https://www.cisco.com/techsupport
Copyright (c) 1986-2013 by Cisco Systems, Inc.
Compiled Fri 22-Nov-13 07:10 by prod_rel_team'
lldp_system_name: ME-DC-1-ACC-SW
mac: 5c5b353e5299
model: AP41
mxedge_id: 00000000-0000-0000-1000-43a81f238391
mxtunnel_status: down
org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
power_constrained: false
power_opmode: ''
site_id: a8178443-ecb5-461c-b854-f16627619ab3
sku: AP41-US
timestamp: 1596588619.007
uptime: 85280
version: 0.7.20216
wlans:
- id: 28c36fc7-dc22-4960-9d81-34087511c2e5
ssid: Live-Demo-NAC
- id: 51b82e2b-f9e8-470b-a32a-cecde5501b0f
ssid: Live-Demo
start: 0
total: 0
EventsDevicesExample:
value:
end: 1531862583
limit: 2
next: /api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/devices/events/search?ap=5c5b350e0001&end=1531855849.000&limit=2&start=1531776183.0
results:
- chassis_mac: 60c78d939c0f
count: 1
device_type: switch
mac: 60c78d939c0f
model: EX4100-48MP
org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
port_id: ge-0/0/17
site_id: 978c48e6-6ef6-11e6-8bbf-02e208b2d34f
text: ifIndex 533, ifAdminStatus up(1), ifOperStatus down(2), ifName ge-0/0/17
timestamp: 1764236687.435
type: SW_PORT_DOWN
version: 23.4R2-S4.11
- ap: 5c5b35d0077b
device_type: ap
mac: 5c5b35d0077b
model: AP43
org_id: 9777c1a0-6ef6-11e6-8bbf-02e208b2d34f
site_id: 46fc665e-9706-4296-8fe2-78f42f2e67e4
timestamp: 1764235684.467825
type: AP_CONFIGURED
start: 1531776183
total: 14
DevicesSearchSwitch:
value:
end: 0
limit: 0
next: string
results:
- clustered: false
evpn_missing_links: false
evpntopo_id: ''
ext_ip: 0.0.0.0
hostname:
- ld-cup-idf-bbb
ip: 10.0.0.217
last_config_status: success
last_hostname: ld-cup-idf-bbb
last_trouble_code: '106'
last_trouble_timestamp: 1719540
mac: 00c78d939c00
mist_configured: true
model: EX4100-48MP
num_members: 1
org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
role: ''
site_id: a8178443-ecb5-461c-b854-f16627619ab3
time_drifted: false
timestamp: 1733998766.256
type: switch
uptime: 19287811
version: 22.4R3.25
start: 0
total: 0
HTTP403Example:
value:
detail: You do not have permission to perform this action.
DevicesSearchGateway:
value:
end: 0
limit: 0
next: string
results:
- clustered: true
evpn_missing_links: false
evpntopo_id: ''
ext_ip: 250.242.0.102
hostname:
- wan-teleworker
- 00ec77599d00
- router
ip: 250.242.0.102
last_config_status: success
last_hostname: wan-teleworker
mac: 00ec77599d00
mist_configured: true
model: SSR120
node: node1
node0_mac: 00ec77599d00
node1_mac: 00ec77599d01
num_members: 0
org_id: 6748cfa6-4e12-11e6-9188-0242ac110007
role: ''
site_id: a8178443-ecb5-461c-b854-f16627619ab3
t128agent_version: 3.8.0-201
time_drifted: false
timestamp: 1734001399.025
type: gateway
uptime: 3586951
version: 6.2.5-5.r2
start: 0
total: 0
Devicegateway:
value:
additional_config_cmds:
- set snmp community public
created_time: 0
deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
dhcpd_config:
corp:
dns_servers:
- 8.8.8.8
- 4.4.4.4
- 2001:4860:4860::8888
dns_suffix:
- .mist.local
- .mist.com
fixed_bindings:
5684dae9ac8b:
ip: 192.168.70.35
name: John
gateway: 192.168.70.1
ip_end: 192.168.70.200
ip_start: 192.168.70.100
type: local
enabled: true
extra_routes:
0.0.0.0/0:
via: 10.2.1.1
id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
image1_url: https://url/to/image.png
ip_configs:
corp:
ip: 192.168.10.1
type: static
mist_configured: true
modified_time: 0
name: corp-a135
ntp_servers:
- pool.ntp.org
- time.google.com
oob_ip_config:
ip: 192.168.50.3
netmask: 255.255.255.0
type: static
org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
port_config:
cl-0/0/1:
ip_config:
type: pppoe
usage: wan
ge-0/0/0:
ip_config:
type: dhcp
usage: wan
ge-0/0/0,ge-7/0/0:
reth_idx: 3
usage: wan
ge-0/0/1-5:
usage: lan
ge-0/0/7:
ip_config:
type: static
usage: wan
site_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
type: gateway
vars:
RADIUS_IP1: 172.31.2.5
RADIUS_SECRET: 11s64632d
DeviceAp:
value:
aeroscout:
enabled: false
host: aero.pvt.net
locate_connected: true
airista:
enabled: false
ble_config:
beacon_enabled: false
beacon_rate: 3
beacon_rate_mode: custom
beam_disabled:
- 1
- 3
- 6
custom_ble_packet_enabled: false
custom_ble_packet_frame: 0x........
custom_ble_packet_freq_msec: 300
eddystone_uid_adv_power: -65
eddystone_uid_beams: 2-4,7
eddystone_uid_enabled: false
eddystone_uid_freq_msec: 200
eddystone_uid_instance: 5c5b35000001
eddystone_uid_namespace: 2818e3868dec25629ede
eddystone_url_adv_power: -65
eddystone_url_beams: 2-4,7
eddystone_url_enabled: true
eddystone_url_freq_msec: 1000
eddystone_url_url: https://www.abc.com
ibeacon_adv_power: -65
ibeacon_beams: 2-4,7
ibeacon_enabled: false
ibeacon_freq_msec: 0
ibeacon_major: 13
ibeacon_minor: 138
ibeacon_uuid: f3f17139-704a-f03a-2786-0400279e37c3
power: 6
power_mode: custom
centrak:
enabled: false
client_bridge:
auth:
psk: foryoureyesonly
type: psk
enabled: false
ssid: Uplink-SSID
created_time: 0
deviceprofile_id: 6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9
disable_eth1: false
disable_eth2: false
disable_eth3: false
disable_module: false
esl_config:
cacert: string
channel: 3
enabled: false
host: 1.1.1.1
port: 0
type: imagotag
verify_cert: true
vlan_id: 1
for_site: true
height: 2.75
id: 497f6eca-6276-4993-bfeb-53cbbbba6008
image1_url: string
image2_url: string
image3_url: string
iot_config:
A1:
enabled: false
name: motion
output: true
pullup: internal
value: 0
A2:
enabled: false
name: motion
output: true
pullup: internal
value: 0
A3:
enabled: false
name: motion
output: true
pullup: internal
value: 0
A4:
enabled: false
name: motion
output: true
pullup: internal
value: 0
DI1:
enabled: false
name: string
pullup: internal
DI2:
enabled: false
name: string
pullup: internal
DO:
enabled: false
name: motion
output: true
pullup: internal
value: 0
ip_config:
dns:
- 8.8.8.8
- 4.4.4.4
dns_suffix:
- .mist.local
- .mist.com
gateway: 10.2.1.254
gateway6: 2607:f8b0:4005:808::1
ip: 10.2.1.1
ip6: 2607:f8b0:4005:808::2004
mtu: 1500
netmask: 255.255.255.0
netmask6: /32
type: static
type6: static
vlan_id: 1
led:
brightness: 255
enabled: true
locked: true
map_id: 63eda950-c6da-11e4-a628-60f81dd250cc
mesh:
enabled: false
group: 1
role: base
modified_time: 0
name: conference room
notes: slightly off center
ntp_servers:
- string
org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b
orientation: 45
poe_passthrough: false
pwr_config:
base: 2000
prefer_usb_over_wifi: false
site_id: 72771e6a-6f5e-4de4-a5b9-1266c4197811
type: ap
uplink_port_config:
dot1x: false
keep_wlans_up_if_down: false
usb_config:
cacert: string
channel: 3
enabled: true
host: 1.1.1.1
port: 0
type: imagotag
verify_cert: true
vlan_id: 1
vars:
RADIUS_IP1: 172.31.2.5
RADIUS_SECRET: 11s64632d
x: 53.5
y: 173.1
HTTP429Example:
value:
detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
responses:
OK:
description: OK
HTTP404:
content:
application/json:
schema:
$ref: '#/components/schemas/response_http404'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/response_http404'
description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
Count:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/CountExample'
schema:
$ref: '#/components/schemas/response_count'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/CountExample'
schema:
$ref: '#/components/schemas/response_count'
description: Result of Count
HTTP403:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP403Example'
schema:
$ref: '#/components/schemas/response_http403'
description: Permission Denied
HTTP401:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP401Example'
schema:
$ref: '#/components/schemas/response_http401'
description: Unauthorized
EventsDevices:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/EventsDevicesExample'
schema:
$ref: '#/components/schemas/response_events_devices'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/EventsDevicesExample'
schema:
$ref: '#/components/schemas/response_events_devices'
description: OK
HTTP429:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP429Example'
schema:
$ref: '#/components/schemas/response_http429'
description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
HTTP400:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/HTTP400Example'
schema:
$ref: '#/components/schemas/response_http400'
description: Bad Syntax
DevicesArray:
content:
application/json:
schema:
$ref: '#/components/schemas/config_devices'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/config_devices'
description: OK
ConfigsHistorySearch:
content:
application/json:
examples:
Example:
$ref: '#/components/examples/ConfigsHistorySearchExample'
schema:
$ref: '#/components/schemas/response_config_history_search'
application/vnd.api+json:
examples:
Example:
$ref: '#/components/examples/ConfigsHistorySearchExample'
schema:
$ref: '#/components/schemas/response_config_history_search'
description: OK
Device:
content:
application/json:
examples:
Ap:
$ref: '#/components/examples/DeviceAp'
gateway:
$ref: '#/components/examples/Devicegateway'
switch:
$ref: '#/components/examples/Deviceswitch'
schema:
$ref: '#/components/schemas/mist_device'
application/vnd.api+json:
examples:
Ap:
$ref: '#/components/examples/DeviceAp'
gateway:
$ref: '#/components/examples/Devicegateway'
switch:
$ref: '#/components/examples/Deviceswitch'
schema:
$ref: '#/components/schemas/mist_device'
description: OK
DevicesSearch:
content:
application/json:
examples:
Ap:
$ref: '#/components/examples/DevicesSearchAp'
Gateway:
$ref: '#/components/examples/DevicesSearchGateway'
Switch:
$ref: '#/components/examples/DevicesSearchSwitch'
schema:
$ref: '#/components/schemas/response_device_search'
application/vnd.api+json:
examples:
Ap:
$ref: '#/components/examples/DevicesSearchAp'
Gateway:
$ref: '#/components/examples/DevicesSearchGateway'
Switch:
$ref: '#/components/examples/DevicesSearchSwitch'
schema:
$ref: '#/components/schemas/response_device_search'
description: OK
File:
content:
application/json:
schema:
contentMediaType: application/octet-stream
description: File
type: string
application/vnd.api+json:
schema:
contentMediaType: application/octet-stream
description: File
type: string
description: OK
securitySchemes:
apiToken:
description: "Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.\n\n**Format**:\n API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information."
in: header
name: Authorization
type: apiKey
basicAuth:
description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
scheme: basic
type: http
csrfToken:
description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```"
in: header
name: X-CSRFToken
type: apiKey