Site settings refer to the configuration and management of of site within a Mist Organization. These settings include access point settings, firmware upgrade schedules, and various features such as location services, occupancy analytics, and engagement analytics.
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2604.1.1**
>
> Date: **May 13, 2026**
<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>
---
## 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 Setting 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: 'Site settings refer to the configuration and management of of site within a Mist Organization.
These settings include access point settings, firmware upgrade schedules, and various features such as location services, occupancy analytics, and engagement analytics.'
name: Sites Setting
paths:
/api/v1/sites/{site_id}/setting:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get the Site Settings
operationId: getSiteSetting
responses:
'200':
$ref: '#/components/responses/SiteSettings'
'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: getSiteSetting
tags:
- Sites Setting
put:
description: Update Site Settings
operationId: updateSiteSettings
requestBody:
content:
application/json:
examples:
Example:
value:
additional_config_cmds:
- set snmp community public
analytic:
enabled: false
ap_matching:
enabled: true
rules:
- match_model: string
name: string
port_config:
eth1,eth2:
disabled: true
dynamic_vlan:
default_vlan_id: 999
enabled: true
port_vlan_id: 1
vlan_id: 9
vlan_ids: 1, 10, 50
ap_port_config:
model_specific:
AP32:
eth1,eth2:
port_vlan_id: 1
vlan_ids: 1, 10, 50
auto_upgrade:
custom_versions:
AP21: stable
AP41: 0.1.5135
AP61: 0.1.7215
day_of_week: sun
enabled: false
time_of_day: '12:00'
version: beta
config_auto_revert: false
device_updown_threshold: 0
dns_servers:
- string
dns_suffix:
- string
engagement:
dwell_tag_names:
bounce: Bounce
engaged: Engaged
passerby: Passer By
stationed: Stationed
dwell_tags:
bounce: null
engaged: 300-14400
passerby: null
stationed: 14400-43200
hours:
fri: 09:00-17:00
mon: 09:00-17:00
sat: 09:00-12:00
sun: 09:00-12:00
thu: 09:00-17:00
tue: 09:00-17:00
wed: 09:00-17:00
max_dwell: 43200
min_dwell: 0
evpn_options:
auto_loopback_subnet: 100.101.0.0/16
auto_router_id_subnet: 100.100.0.0/24
core_as_border: false
overlay:
as: 65000
per_vlan_vga_v4_mac: false
routed_at: edge
underlay:
as_base: 65001
routed_id_prefix: /24
subnet: 10.255.240.0/20
gateway_additional_config_cmds:
- set snmp community public
gateway_mgmt:
admin_sshkeys:
- string
app_probing:
apps:
- string
custom_apps:
- app_type: string
hostnames:
- string
name: string
protocol: http
enabled: true
app_usage: true
auto_signature_update:
day_of_week: any
enable: true
time_of_day: string
config_revert_timer: 10
probe_hosts:
- string
root_password: string
security_log_source_address: 192.168.1.1
security_log_source_interface: string
led:
brightness: 255
enabled: true
mxedge_mgmt:
mist_password: MIST_PASSWORD
root_password: ROOT_PASSWORD
networks:
property1:
gateway: string
subnet: string
vlan_id: 10
property2:
gateway: string
subnet: string
vlan_id: 10
ntp_servers:
- string
occupancy:
assets_enabled: false
clients_enabled: true
min_duration: 3000
sdkclients_enabled: false
unconnected_clients_enabled: false
ospf_areas:
property1:
include_loopback: false
networks:
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: default
property2:
include_loopback: false
networks:
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: default
persist_config_on_device: false
port_mirroring:
property1:
input_networks_ingress:
- corp
input_port_ids_egress:
- ge-0/0/3
input_port_ids_ingress:
- ge-0/0/3
output_network: analyze
output_port_id: ge-0/0/5
property2:
input_networks_ingress:
- corp
input_port_ids_egress:
- ge-0/0/3
input_port_ids_ingress:
- ge-0/0/3
output_network: analyze
output_port_id: ge-0/0/5
port_usages:
dynamic:
mode: dynamic
reset_default_when: link_down
rules:
- equals: string
equals_any:
- string
expression: string
src: lldp_chassis_id
usage: string
property1:
all_networks: false
allow_dhcpd: true
bypass_auth_when_server_down: true
description: string
disable_autoneg: false
disabled: false
duplex: auto
enable_mac_auth: true
enable_qos: true
guest_network: string
mac_auth_only: true
mac_auth_protocol: pap
mac_limit: 0
mode: access
networks:
- string
persist_mac: false
poe_disabled: false
port_auth: dot1x
port_network: string
server_reject_network: null
speed: auto
storm_control:
no_broadcast: false
no_multicast: false
no_registered_multicast: false
no_unknown_unicast: false
percentage: 80
stp_edge: true
voip_network: string
property2:
all_networks: false
allow_dhcpd: true
bypass_auth_when_server_down: true
description: string
disable_autoneg: false
disabled: false
duplex: auto
enable_mac_auth: true
enable_qos: true
guest_network: string
mac_auth_only: true
mac_auth_protocol: pap
mac_limit: 0
mode: access
networks:
- string
persist_mac: false
poe_disabled: false
port_network: string
server_reject_network: null
speed: auto
storm_control:
no_broadcast: false
no_multicast: false
no_registered_multicast: false
no_unknown_unicast: false
percentage: 80
stp_edge: true
voip_network: string
proxy:
url: http://proxy.internal:8080/*
rogue:
enabled: false
honeypot_enabled: false
min_duration: 10
min_rssi: -80
whitelisted_bssids:
- NeighborSSID
whitelisted_ssids:
- cc:8e:6f:d4:bf:16
- cc-8e-6f-d4-bf-16
- cc-73-*
- cc:82:*
simple_alert:
arp_failure:
client_count: 10
duration: 20
incident_count: 10
dhcp_failure:
client_count: 10
duration: 10
incident_count: 20
dns_failure:
client_count: 20
duration: 10
incident_count: 30
skyatp:
enabled: true
send_ip_mac_mapping: true
srx_app:
enabled: false
ssh_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...Wxa6p6UW0ZbcP john@host
ssr:
conductor_hosts:
- '"1.1.1.1", "2.2.2.2"'
disable_stats: true
status_portal:
enabled: false
hostnames:
- my.misty.com
vars:
RADIUS_IP1: 172.31.2.5
RADIUS_SECRET: 11s64632d
vna:
enabled: false
wan_vna:
enabled: false
wids:
repeated_auth_failures:
duration: 60
threshold: 0
wifi:
cisco_enabled: true
disable_11k: false
disable_radios_when_power_constrained: false
enable_arp_spoof_check: false
enable_shared_radio_scanning: true
enabled: true
locate_connected: true
locate_unconnected: false
mesh_allow_dfs: false
mesh_enable_crm: false
mesh_enabled: false
mesh_psk: string
mesh_ssid: string
proxy_arp: default
wired_vna:
enabled: false
zone_occupancy_alert:
email_notifiers:
- foo@juniper.net
- bar@juniper.net
enabled: false
threshold: 5
schema:
$ref: '#/components/schemas/site_setting'
description: Request Body
responses:
'200':
$ref: '#/components/responses/SiteSettings'
'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: updateSiteSettings
tags:
- Sites Setting
/api/v1/sites/{site_id}/setting/blacklist:
parameters:
- $ref: '#/components/parameters/site_id'
delete:
description: Delete Site Blacklist Station Clients
operationId: deleteSiteWirelessClientsBlocklist
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: deleteSiteWirelessClientsBlocklist
tags:
- Sites Setting
post:
description: 'This endpoint is to provide list of client macs for annotation blacklist.
Retrieve the current clients list `blacklist_url` under Site:Setting'
operationId: createSiteWirelessClientsBlocklist
requestBody:
content:
application/json:
examples:
Example:
value:
macs:
- 18-65-90-de-f4-c6
- 84-89-ad-5d-69-0d
schema:
$ref: '#/components/schemas/mac_addresses'
description: Request Body
responses:
'200':
$ref: '#/components/responses/MacsArray'
'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: createSiteWirelessClientsBlocklist
tags:
- Sites Setting
/api/v1/sites/{site_id}/setting/derived:
parameters:
- $ref: '#/components/parameters/site_id'
get:
description: Get the Derived Site Settings, generated by merging the Org level templates (network templates, gateway templates) and the Site level configuration. If the same parameter is defined in both scopes, the Site level one is used. In addition, the Zoom and Teams accounts are also merged into the derived settings.
operationId: getSiteSettingDerived
responses:
'200':
$ref: '#/components/responses/SiteSettingsDerived'
'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: getSiteSettingDerived
tags:
- Sites Setting
/api/v1/sites/{site_id}/setting/watched_station:
parameters:
- $ref: '#/components/parameters/site_id'
delete:
description: Delete Site Watched Station Clients
operationId: deleteSiteWatchedStations
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: deleteSiteWatchedStations
tags:
- Sites Setting
post:
description: 'This endpoint is to provide list of client macs for annotation as watched station.
Retrieve the current clients list from `watched_station_url` under Site:Setting'
operationId: createSiteWatchedStations
requestBody:
content:
application/json:
examples:
Example:
value:
macs:
- 18-65-90-de-f4-c6
- 84-89-ad-5d-69-0d
schema:
$ref: '#/components/schemas/mac_addresses'
description: Request Body
responses:
'200':
$ref: '#/components/responses/MacsArray'
'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: createSiteWatchedStations
tags:
- Sites Setting
/api/v1/sites/{site_id}/setting/whitelist:
parameters:
- $ref: '#/components/parameters/site_id'
delete:
description: Delete Site Whitelist Station Clients
operationId: deleteSiteWirelessClientsAllowlist
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: deleteSiteWirelessClientsAllowlist
tags:
- Sites Setting
post:
description: 'This endpoint is to provide list of client macs for annotation as whitelist.
Retrieve the current clients list from `whitelist_url` under Site:Setting'
operationId: createSiteWirelessClientsAllowlist
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mac_addresses'
description: Request Body
responses:
'200':
$ref: '#/components/responses/MacsArray'
'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: createSiteWirelessClientsAllowlist
tags:
- Sites Setting
components:
schemas:
switch_auto_upgrade_custom_versions:
additionalProperties:
type: string
description: Custom version to be used. The Property Key is the switch hardware and the property value is the firmware version
examples:
- QFX5120-32C: 23.4R2-S2.1
QFX5130-32CD: 23.4R2-S2.3
type: object
protect_re_custom_protocol:
default: any
description: 'enum: `any`, `icmp`, `tcp`, `udp`'
enum:
- any
- icmp
- tcp
- udp
type: string
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
mxcluster_rad_auth_server_keywrap_format:
default: ascii
description: 'if used for Mist APs. enum: `ascii`, `hex`'
enum:
- ascii
- hex
type:
- string
- 'null'
site_setting_paloalto_networks:
additionalProperties: false
properties:
gateways:
$ref: '#/components/schemas/site_setting_paloalto_networks_gateways'
send_mist_nac_user_info:
default: false
type: boolean
type: object
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
juniper_srx_auto_upgrade_custom_versions:
additionalProperties:
description: Firmware version to deploy on the specified SRX hardware
examples:
- 23.4R2-S2.1
type: string
description: Property key is the SRX Hardware model (e.g. "SRX4600")
type: object
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
service_policy_secintel_profile:
default: default
description: 'enum: `default`, `standard`, `strict`'
enum:
- default
- standard
- strict
type: string
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
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
gateway_extra_route6:
additionalProperties: false
properties:
via:
format: ipv6
type: string
type: object
mxcluster_radsec:
additionalProperties: false
description: MxEdge RadSec Configuration
properties:
acct_servers:
$ref: '#/components/schemas/mxcluster_radsec_acct_servers'
auth_servers:
$ref: '#/components/schemas/mxcluster_radsec_auth_servers'
enabled:
description: Whether to enable service on Mist Edge i.e. RADIUS proxy over TLS
type: boolean
match_ssid:
description: Whether to match ssid in request message to select from a subset of RADIUS servers
type: boolean
nas_ip_source:
$ref: '#/components/schemas/mxcluster_radsec_nas_ip_source'
proxy_hosts:
$ref: '#/components/schemas/mxcluster_radsec_proxy_hosts'
server_selection:
$ref: '#/components/schemas/mxcluster_radsec_server_selection'
src_ip_source:
$ref: '#/components/schemas/mxcluster_radsec_src_ip_source'
type: object
vrrp_group_auth_type:
default: md5
description: 'enum: `md5`, `simple`'
enum:
- md5
- simple
examples:
- md5
type: string
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
site_rogue:
additionalProperties: false
description: Rogue site settings
properties:
allowed_vlan_ids:
$ref: '#/components/schemas/vlan_ids'
enabled:
default: false
description: Whether rogue detection is enabled
type: boolean
honeypot_enabled:
default: false
description: Whether honeypot detection is enabled
type: boolean
min_duration:
default: 10
description: Minimum duration for a bssid to be considered neighbor
examples:
- 10
maximum: 59
type: integer
min_rogue_duration:
default: 10
description: Minimum duration for a bssid to be considered rogue
examples:
- 10
maximum: 59
type: integer
min_rogue_rssi:
default: -80
description: Minimum RSSI for an AP to be considered rogue
examples:
- -80
minimum: -85
type: integer
min_rssi:
default: -80
description: Minimum RSSI for an AP to be considered neighbor (ignoring APs that’s far away)
examples:
- -80
minimum: -85
type: integer
whitelisted_bssids:
$ref: '#/components/schemas/site_rogue_whitelisted_bssids'
whitelisted_ssids:
$ref: '#/components/schemas/site_rogue_whitelisted_ssids'
type: object
vars_annotation:
additionalProperties: false
description: Annotation for a single var, helping identify its purpose and enabling auto-complete/enumeration in UI
properties:
note:
description: User-provided note to describe what this var was created for
type: string
type:
default: generic
description: 'Used to identify where to enumerate / auto-complete the field from. Default is `generic` (plain string, no special handling).
enum: `generic`, `mxtunnel_id`'
type: string
type: object
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 s
# --- truncated at 32 KB (333 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist-ai/refs/heads/main/openapi/mist-ai-sites-setting-api-openapi.yml