Mist Sites Setting API
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.
Mist Sites Setting API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sites Setting. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 9 operations across 5 paths, and defines 616 schemas. It is described by OpenAPI 3.2.0, at version 2606.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
9 operations
5 paths
616 schemas
3 DELETE2 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Mist Sites Setting API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…csrfToken— Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 3 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Sites Setting 9
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 variou…
GET
/api/v1/sites/{site_id}/setting
getSiteSetting
PUT
/api/v1/sites/{site_id}/setting
updateSiteSettings
DELETE
/api/v1/sites/{site_id}/setting/blacklist
deleteSiteWirelessClientsBlocklist
POST
/api/v1/sites/{site_id}/setting/blacklist
createSiteWirelessClientsBlocklist
GET
/api/v1/sites/{site_id}/setting/derived
getSiteSettingDerived
DELETE
/api/v1/sites/{site_id}/setting/watched_station
deleteSiteWatchedStations
POST
/api/v1/sites/{site_id}/setting/watched_station
createSiteWatchedStations
DELETE
/api/v1/sites/{site_id}/setting/whitelist
deleteSiteWirelessClientsAllowlist
POST
/api/v1/sites/{site_id}/setting/whitelist
createSiteWirelessClientsAllowlist
Schemas 616
The contract defines 616 schemas that model the data the API accepts and returns. The most detailed are site_setting (101 properties), gateway_port_config (48 properties), switch_port_usage (46 properties), account_oauth_info_account (32 properties). Each schema is shown below with its type and property counts.
switch_port_usage_dynamic_rule
object
Dynamic port usage rule evaluated against LLDP, RADIUS, or peer MAC attributes
6 properties
1 required
switch_mist_nac
object
Mist NAC RadSec settings for a switch
2 properties
synthetictest_config_probes
array
app name comes from customprobes above or /const/synthetictestprobes
gateway_mgmt
object
Gateway management-plane and access settings
15 properties
service_policy_skyatp_dns_tunnel_detection_profile
string
enum: default, standard, strict
dhcpd_config_property
object
DHCP server or relay configuration for one network
16 properties
radius_acct_server
object
RADIUS accounting server settings
7 properties
2 required
ntp_servers
array
List of NTP servers specific to this device. By default, those in Site Settings will be used
junos_port_config
object
Junos switch port configuration
19 properties
1 required
time_of_day
string
any / HH:MM (24-hour format)
vrf_extra_route6
object
Additional IPv6 static route for a VRF instance
1 property
gateway_ip_configs
object
Property key is the network name
remote_syslog_server_protocol
string
Transport protocol used for this remote syslog server. enum: tcp, udp
ospf_area
object
Property key is the OSPF Area (Area should be a number (0-255) / IP address)
3 properties
tunnel_config
object
Gateway tunnel configuration for provider-managed or custom tunnels
18 properties
network_multicast_groups
object
Group address to RP (rendezvous point) mapping. Property Key is the CIDR (example "225.1.0.3/32")
strings
array
Unique string values returned or accepted by this schema
network_source_nat
object
If routed==false (usually at Spoke), but some hosts needs to be reachable from Hub
1 property
sw_routing_policy_term_action
object
Actions applied to routes matched by a switch routing policy term
4 properties
tunnel_config_probe_type
string
Protocol used by the custom IPsec tunnel health probe. enum: http, icmp
switch_bgp_config_hold_time_zero
integer
BGP hold time value of 0
radsec
object
RadSec settings for sending RADIUS traffic over TLS
9 properties
mxcluster_radsec_auth_servers
array
List of RADIUS authentication servers, order matters where the first one is treated as primary
routing_policy_term_matching_prefix
array
zero or more criteria/filter can be specified to match the term, all criteria have to be met
gateway_ip_config_property
object
Gateway network interface IP configuration
7 properties
marvis
object
Marvis automation and client settings
1 property
synthetictest_config_custom_probe
object
Custom probe definition for synthetic tests
4 properties
site_setting_juniper_srx_gateway
object
Juniper SRX gateway API connection settings
3 properties
remote_syslog_users
array
User-specific syslog logging rules
switch_bgp_config_neighbors
object
Switch BGP neighbor settings keyed by neighbor IP address
idp_profile_matching
object
Criteria that select IDP signatures for an overwrite rule
3 properties
switch_radius_config
object
Switch RADIUS authentication and accounting configuration
12 properties
dhcpd_config_vendor_option
object
Vendor-encapsulated DHCP option value
2 properties
site_mxtunnel_clusters
array
Tunnel peer cluster definitions APs use for the site Mist Tunnel
ospf_area_type
string
OSPF type. enum: default, nssa, stub
service_policy_skyatp_iot_device_policy
object
Sky ATP IoT device policy settings
1 property
routing_policy_term_action_prepend_as_path
array
When used as export policy, optional. By default, the local AS will be prepended, to change it. Can be a Variable (e.g. {{aspath}})
ip_type6
string
enum: autoconf, dhcp, disabled, static
vrf_extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
gateway_port_config
object
Gateway port configuration for LAN, WAN, tunnel, and HA interfaces
48 properties
1 required
network_tenants
object
Property key must be the user/tenant name (i.e. "printer-1") or a Variable (i.e. "{{myvar}}")
switch_bgp_config_neighbor
object
Per-neighbor switch BGP session settings
5 properties
1 required
ospf_area_network_interface_type
string
interface type (nbma = non-broadcast multi-access). enum: broadcast, nbma, p2mp, p2p
snmp_config_client_list
object
SNMP client allowlist definition
2 properties
proxy
object
Proxy Configuration to talk to Mist
2 properties
ibeacon_minor
integernull
Minor number for iBeacon
switch_mgmt_mxedge_proxy_port
Mist Edge port used to proxy the switch management traffic to the Mist Cloud. Value in range 1-65535
gateway_path_preferences
object
Gateway path preference that selects among one or more local, WAN, VPN, or tunnel paths
2 properties
aggregate_route
object
Aggregate route configuration for a network or routing instance
3 properties
system_defined_port_usages
string
system-default port usages. enum: ap, iot, uplink
gateway_extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64"), the destination Network name or a variable (e.g. "{{myvar}}")
dhcp_snooping
object
DHCP snooping security settings
5 properties
tunnel_config_provider
string
Only if autoprovision.enabled==false. enum: custom-ipsec, custom-gre, jse-ipsec, prisma-ipsec, zscaler-gre, zscaler-ipsec
switch_auto_upgrade_container
object
Wrapper for switch firmware auto-upgrade settings
1 property
additional_vlan_ids_array
array
Additional VLAN IDs represented as an array
gateway_ip_config_property_second_ips
array
Optional list of secondary IPs in CIDR format
dot11_bandwidth24
integer
channel width for the 2.4GHz band. enum: 0(disabled, response only), 20, 40
remote_syslog_servers
array
Remote syslog server destination list
ap_auto_upgrade_custom_versions
object
Per-AP-model firmware versions or channels used for auto-upgrade. Property key is the AP model name (e.g. "AP41"), value is the firmware version or release cha…
sw_routing_policy_term_matching_protocol_enum
string
enum: bgp, direct, evpn, ospf, static
network_internet_access_static_nat
object
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}}")
idp_profile_matching_severity
array
Severity levels matched by an IDP profile overwrite
site_setting_critical_url_monitoring_monitors
array
Critical URL monitor definitions for site health
mxcluster_radsec_src_ip_source
string
Specify IP address to connect to authservers and acctservers. enum: any, oob, oob6, tunnel, tunnel6
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
hour
string
Hour range of the day (e.g. 09:00-17:00). If the hour is not defined then it's treated as 00:00-23:59.
tunnel_config_ipsec_proposals
array
Only if provider==custom-ipsec. IPsec proposals used for custom IPsec negotiation
snmp_config_engine_id_type
string
Method used to derive the SNMP engine ID. enum: local, usemacaddress
gateway_mgmt_probe_hostsv6
array
IPv6 probe hosts used for gateway connectivity checks
switch_port_usage_dynamic_rule_src
string
enum: linkpeermac, lldpchassisid, lldphardwarerevision, lldpmanufacturername, lldpoui, lldpserialnumber, lldpsystemdescription, lldpsystemname, radiusdynamicfi…
snmp_config_trap_groups
array
SNMP trap group definitions
snmp_vacm_access_item_type
string
VACM context matching type for this access rule. enum: contextprefix, defaultcontextprefix
snmpv3_config_notify_items
object
SNMPv3 notification definition for traps or informs
3 properties
mist_nacedge_mxedge_hosts
array
List of NAC Edges used for the Site Survivability feature
switch_bgp_config
object
Switch BGP configuration for a routing instance
9 properties
2 required
site_setting_skyatp
object
Sky ATP threat intelligence settings for the site
2 properties
snmp_vacm_access_item
object
VACM access rule for an SNMP group
2 properties
day_of_week
string
enum: any, fri, mon, sat, sun, thu, tue, wed
idp_profile_action
string
IDP profile action. enum: alert, close, drop. alert is the default, drop silently drops packets, and close asks the client/server to close the connection
idp_profile_matching_dst_subnet
array
Destination CIDR subnets matched by an IDP profile overwrite
site_setting_mxedge
object
Service settings for the site Mist Edge cluster
4 properties
extra_route
object
IPv4 static route settings for a destination prefix
6 properties
wan_extra_routes
object
Additional IPv4 route for a WAN interface
1 property
gateway_idp_profiles
object
Property key is the profile name
ssr_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
config_switch_local_accounts
object
Property key is the user name. For Local user authentication
tunnel_config_tunnel_mode
string
Required if provider==zscaler-gre, provider==jse-ipsec. enum: active-active, active-standby
snmpv3_config_target_param_security_level
string
enum: authentication, none, privacy
snmp_config_client_list_clients
array
SNMP client IP addresses or CIDR ranges allowed by a client list
protect_re_trusted_hosts
array
Host or subnet entries allowed by the Protect RE policy
gw_routing_policy_term_action
object
Actions applied to routes matched by a gateway routing policy term
9 properties
ap_led
object
Indicator light settings for an access point
2 properties
vrf_extra_route
object
Additional IPv4 static route for a VRF instance
1 property
snmp_usm_engine_type
string
SNMP engine type used for this USM configuration. enum: localengine, remoteengine
ap_radio_antenna_mode
string
enum: 1x1, 2x2, 3x3, 4x4, default
gw_routing_policy
object
Gateway routing policy made of ordered match-action terms
1 property
gateway_path_preferences_paths
array
Candidate paths evaluated by a gateway path preference
gw_routing_policy_term_matching_route_exists
object
Route-existence match condition for a gateway routing policy term
2 properties
mxcluster_radsec
object
RadSec proxy configuration for a Mist Edge cluster. Used when the Mist Edge Cluster is used as a RADIUS Proxy between the local devices and external RADIUS Ser…
8 properties
tunnel_config_auth_algo
string
enum: md5, sha1, sha2
setting_ssr_auto_upgrade_custom_versions
object
Property key is the SSR model (e.g. "SSR130").
remote_syslog_time_format
string
enum: millisecond, year, year millisecond
acl_tag_ether_types
array
ARP / IPv6. Default is any
dhcpd_config_options
object
If type==local or type6==local. Property key is the DHCP option number
site_setting_ap_matching_rules
array
Ordered AP matching rules for applying port configuration
ap_radio_band6
object
6 GHz radio settings for an access point
13 properties
switch_matching
object
Defines custom switch configuration based on different criteria
2 properties
switch_port_usage_dot1x
stringnull
Only if mode!=dynamic. If dot1x is desired, set to dot1x. enum: dot1x
network_vpn_access_static_nat_property
object
VPN access static NAT rule target settings
2 properties
service_policy_secintel_profile
string
enum: default, standard, strict
switch_port_usage_reauth_interval
Only if mode!=dynamic and portauth=dot1x reauthentication interval range (min: 10, max: 65535, default: 3600). Set to 0 to disable reauthentication (no-reauthe…
ssl_proxy_ciphers_category
string
enum: medium, strong, weak
snmp_vacm_access_item_prefix_list_item
object
Context prefix rule for a VACM access entry
7 properties
gateway_matching
object
Gateway matching configuration used to apply gateway-specific settings
2 properties
gateway_wan_type
string
enum: dhcp, pppoe, static
ap_port_config_forwarding
string
enum: all: local breakout, All VLANs limited: local breakout, only the VLANs configured in portvlanid and vlanids mxtunnel: central breakout to an Org Mist Edg…
mac_addresses
object
Request containing one or more MAC addresses
1 property
1 required
site_auto_upgrade_version
string
desired version. enum: beta, custom, stable
evpn_options_underlay
object
EVPN underlay BGP and subnet settings
4 properties
site_setting_disabled_system_defined_port_usages
array
If some system-default port usages are not desired - namely, ap / iot / uplink
extra_route6_next_qualified_properties
object
Qualified next-hop attributes for an IPv6 static route
2 properties
extra_route6
object
IPv6 static route settings for a destination prefix
6 properties
snmpv3_config_target_param_security_model
string
enum: usm, v1, v2c
network_internet_access_destination_nat_property
object
Direct-internet destination NAT rule target settings
4 properties
site_wids
object
Wireless intrusion detection settings for a site
1 property
routing_policy_term_action_community
array
When used as export policy, optional
account_oauth_info_account_region
object
Prisma Access region bandwidth allocation for a linked OAuth account
3 properties
mxcluster_nac_client_ip
object
Mist NAC client settings for a RADIUS client IP or subnet
4 properties
mxcluster_radsec_acct_server
object
RadSec accounting server settings for a Mist Edge cluster
4 properties
switch_port_usage
object
Junos switch port usage template and authentication settings
46 properties
mxcluster_radsec_auth_server
object
RadSec authentication server settings for a Mist Edge cluster
12 properties
service_policy_syslog
object
Syslog logging settings for a service policy
2 properties
service_policy_skyatp_dns_dga_detection_profile
string
enum: default, standard, strict
idp_profile_overwrite
object
Override rule that changes the IDP action for matching signatures
3 properties
vars_annotations
object
Optional annotations for vars defined in this site. Keys match var names; values describe the var purpose and type for UI auto-complete.
service_policy_skyatp_dns_tunnel_detection
object
Sky ATP DNS tunneling detection settings
2 properties
iotproxy
object
IoT proxy configuration for the site
2 properties
service_policy_ewf_rule_profile
string
enum: critical, standard, strict
snmp_config_trap_group_categories
array
Trap categories included in an SNMP trap group
switch_port_usages
object
Property key is the port usage name. Defines the profiles of port configuration configured on the switch
tunnel_provider_options_zscaler
object
For zscaler-ipsec and zscaler-gre
15 properties
tunnel_provider_options_jse
object
For jse-ipsec, this allows provisioning of adequate resource on JSE. Make sure adequate licenses are added
2 properties
tunterm_monitoring_item
object
Monitoring check for tunnel termination reachability
5 properties
junos_port_config_duplex
string
enum: auto, full, half
org_id
string
Unique identifier of a Mist organization
tacacs_auth_server
object
TACACS+ authentication server settings
4 properties
switch_radius_config_auth_server_selection
string
Selection strategy for RADIUS authentication servers. enum: ordered, unordered
switch_bgp_config_hold_time
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 vali…
simple_alert_dns_failure
object
Thresholds for DNS failure heuristic alerts
3 properties
aggregate_routes
object
Property key is the destination subnet (e.g. "172.16.3.0/24")
bgp_config
object
BGP session configuration. BFD is enabled when either bfdminimuminterval or bfdmultiplier is configured
22 properties
1 required
site_engagement_dwell_tags
object
Visit duration ranges in seconds used to assign engagement tags
4 properties
snmpv3_config_notify_filter
array
SNMPv3 notification filter profiles
gateway_port_reth_nodes
array
SSR only - supporting vlan-based redundancy (matching the size of networks)
extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8")
setting_ssr_conductor_hosts
array
Conductor IP addresses or hostnames used by SSR devices
mxcluster_radsec_acct_server_ssids
array
List of ssids that will use this server if matchssid is true and match is found
gateway_vrf_instance
object
Gateway VRF instance and its member networks
1 property
switch_port_usage_storm_control
object
Switch storm control. Only if mode!=dynamic
6 properties
mxedge_tunterm_multicast_config_mdns_vlan_ids
array
VLAN IDs where mDNS forwarding is enabled
gateway_path_preferences_path_networks
array
Network names used by a local path; required when type==local
switch_port_usage_mac_limit
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_stp_config
object
Switch spanning-tree protocol configuration
1 property
routing_policy_term_matching_community
array
BGP community values used as routing-policy match criteria
extra_route_next_qualified_properties
object
Qualified next-hop attributes for an IPv4 static route
2 properties
switch_radius
object
Switch RADIUS override settings. By default, the switch radiusconfig is used; set usedifferentradius to use alternate RADIUS settings.
3 properties
site_setting_switch
Site switch settings combining a network template and auto-upgrade controls
switch_port_mirroring_property
object
Input and output settings for one switch port mirroring session
6 properties
site_mxtunnel_cluster
object
Mist Tunnel peer cluster definition for a site
2 properties
site_rogue
object
Rogue AP detection settings for a site
9 properties
ssr_proxy
object
SSR proxy configuration to talk to Mist
2 properties
site_mxtunnel_additional_mxtunnel
object
Additional named Mist Tunnel configuration for a site
5 properties
switch_mgmt
object
Switch management-plane access and proxy settings
16 properties
vrrp_group_networks
object
Property key is the network name
ap_port_config
object
Ethernet port behavior settings for an access point
17 properties
site_mxtunnel_radsec_acct_servers
array
RADIUS accounting servers used by the site Mist Tunnel RadSec proxy
snmp_vacm_access
array
VACM access rules for SNMPv3
service_policy_secintel
object
SRX SecIntel settings for a service policy
3 properties
mxcluster_radsec_server_selection
string
When ordered, Mist Edge will prefer and go back to the first RADIUS server if possible. enum: ordered, unordered
vrrp_group_network
object
Virtual IP assignment for a VRRP network
1 property
snmp_config_trap_group
object
SNMP trap group definition
4 properties
network_internet_access_destination_nat
object
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.1…
network_multicast_group
object
Multicast group rendezvous point mapping
1 property
remote_syslog
object
Remote syslog forwarding settings
10 properties
site_mxtunnel
object
Site Mist Tunnel configuration for tunneling AP user VLANs to Mist Edge tunnel peers
18 properties
snmpv3_config_target_address_item
object
SNMPv3 notification target address entry
6 properties
simple_alert_dhcp_failure
object
Thresholds for DHCP failure heuristic alerts
3 properties
gateway_port_duplex
string
enum: auto, full, half
tunnel_config_remote_subnets
array
List of Remote protected subnet for policy-based IPSec negotiation
switch_matching_rules
array
Ordered switch matching rules for conditional configuration
routing_policy_term_matching_as_path
array
BGP AS path values used as routing-policy match criteria
gateway_extra_route6
object
Gateway IPv6 extra route next-hop settings
1 property
response_http403
object
Standard HTTP 403 permission error response
1 property
gw_routing_policy_terms
array
zero or more criteria/filter can be specified to match the term, all criteria have to be met
tunnel_config_node_hosts
array
Remote gateway host addresses for a tunnel node
service_policy
object
Site-level service policy that allows or denies traffic for tenants and services
15 properties
gateway_port_networks
array
If usage==lan, name of the [networks]($h/Orgs%20Networks/overview) to attach to the interface
site_setting
object
Configuration settings applied at the site level
101 properties
service_policy_skyatp
object
SRX Sky ATP threat inspection settings for a service policy
4 properties
snmp_vacm_security_model
string
enum: usm, v1, v2c
radio_band_24_usage
string
enum: 24, 5, 6, auto
gateway_port_vpn_path
object
VPN path settings for traffic that uses a gateway port
5 properties
radsec_mxcluster_ids
array
To use Org Mist Edges when this WLAN does not use mxtunnel, specify their mxclusterids. Org Mist Edge(s) identified by mxclusterids
dhcpd_config_option
object
Custom DHCP option value
2 properties
mac_addresses_macs
array
Unique MAC addresses included in a request
radio_band_antenna_mode
string
enum: 1x1, 2x2, 3x3, 4x4, default
gateway_traffic_shaping
object
Traffic shaping settings for a gateway interface or VPN path
3 properties
remote_syslog_server_port
Syslog Service Port, value from 1 to 65535
gateway_path_preferences_path
object
Candidate path within a gateway path preference
9 properties
1 required
service_policy_appqoe
object
SRX application QoE settings for a service policy
1 property
site_setting_tunterm_multicast_config
object
Multicast forwarding settings for tunnel termination at the site
3 properties
gateway_extra_route
object
Gateway IPv4 extra route next-hop settings
1 property
site_setting_ap_matching_rule
object
AP matching rule for selecting APs and applying port configuration
3 properties
synthetictest_config_vlan
object
Deprecated VLAN-based synthetic test settings
4 properties
site_wids_repeated_auth_failures
object
Detection settings for repeated authentication failures
2 properties
acl_policies
array
List of ACL policy definitions
snmp_vacm
object
SNMPv3 View-based Access Control Model configuration
2 properties
site_setting_tunterm_multicast_config_mdns
object
mDNS multicast forwarding settings for tunneled VLANs
2 properties
gateway_extra_routes
object
Property key is the destination CIDR (e.g. "10.0.0.0/8"), the destination Network name or a variable (e.g. "{{myvar}}")
tunnel_config_version
string
Only if provider==custom-gre or provider==custom-ipsec. enum: 1, 2
switch_port_mirroring_ingress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
site_setting_paloalto_networks_gateways
array
Palo Alto Networks gateways integrated with a site
radio_band_preamble
string
enum: auto, long, short
evpn_options_routed_at
string
optional, where virtual-gateway should reside. enum: core, distribution, edge
network_vpn_access_config
object
VPN access settings for a network and VPN pair
14 properties
gateway_mgmt_auto_signature_update
object
Automatic security signature update schedule
3 properties
evpn_options_vs_instance
object
EVPN virtual-switch instance network mapping
1 property
ip_type
string
IP address assignment mode, either DHCP or static. enum: dhcp, static
created_time
number
When the object has been created, in epoch
snmp_usm_user
object
SNMPv3 USM user definition
5 properties
remote_syslog_facility
string
enum: any, authorization, change-log, config, conflict-log, daemon, dfc, external, firewall, ftp, interactive-commands, kernel, ntp, pfe, security, user
snmp_config_v2c_configs
array
SNMPv2c community configuration entries for this SNMP profile
tunnel_via
string
If via==tunnel, specifies which tunnel (primary/secondary) this neighbor is associated with. enum: primary, secondary
ap_radio_band24
object
2.4 GHz radio settings for an access point
11 properties
vrf_extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
bgp_config_neighbors
object
Per-neighbor BGP session settings
7 properties
1 required
radius_auth_port
RADIUS Auth Port, value from 1 to 65535, default is 1812
tunnel_config_auto_provision_node_wan_names
array
Optional, only needed if varsonly==false
site_setting_flags
object
Name/val pair objects for location engine to use
gateway_port_config_wan_speedtest_mode
string
Controls whether Marvis/scheduler can run speedtest on this port. enum: auto, enabled, disabled
gateway_oob_ip_config
object
Out-of-band management IP configuration for gateway interfaces such as vme, em0, or fxp0
8 properties
vs_instance_property_networks
array
Network names included in a virtual-switch instance
site_setting_critical_url_monitoring
object
Critical URLs whose latency is measured and included in site health
2 properties
switch_port_usage_mac_auth_protocol
string
Only if mode!=dynamic and enablemacauth ==true. This type is ignored if mistnac is enabled. enum: eap-md5, eap-peap, pap
switch_bgp_config_type
string
BGP session type for this switch BGP configuration. enum: external, internal
app_probing
object
Application reachability probing settings for gateway management
3 properties
synthetictest_config_custom_probe_type
string
enum: application, curl, icmp, reachability, tcp
remote_syslog_content
object
Syslog message content selector for remote logging
2 properties
snmp_config_view
object
SNMP MIB view definition
3 properties
idp_profile_base_profile
string
enum: critical, standard, strict
network_tenant
object
Tenant address entry for a network
1 property
site_setting_ntp_servers
array
List of NTP servers
idp_profile_matching_severity_value
string
enum: critical, info, major, minor
radsec_server
object
External RadSec server settings
2 properties
switch_auto_upgrade
object
Switch firmware auto-upgrade settings
3 properties
mxedge_tunterm_multicast_config_ssdp_vlan_ids
array
VLAN IDs where SSDP forwarding is enabled
radius_auth_server
object
RADIUS authentication server settings
8 properties
2 required
gateway_port_wan_source_nat
object
Only if usage==wan, optional. By default, source-NAT is performed on all WAN Ports using the interface-ip
3 properties
switch_port_usage_dynamic_rules
array
Only if mode==dynamic. Dynamic matching rules that select the port usage to apply
service_policy_antivirus
object
SRX antivirus inspection settings for a service policy
3 properties
site_mxtunnel_ap_subnets
array
List of subnets where we allow AP to establish Mist Tunnels from
site_setting_derived
Site settings with derived OAuth account integration data
acl_tag_macs
array
Required if - type==mac - type==staticgbp if from matching mac
protect_re_custom_subnet
array
Source subnets matched by a custom Protect RE ACL
snmp_usm_user_authentication_type
string
sha224, sha256, sha384, sha512 are supported in 21.1 and newer release. enum: authentication-md5, authentication-none, authentication-sha, authentication-sha22…
snmp_vacm_security_to_group
object
VACM security-name to group mapping configuration
2 properties
synthetictest_config_aggressiveness
string
Aggressiveness level for a synthetic test. enum: auto, high, med, low
dhcpd_config_vendor_options
object
If type==local or type6==local. Property key is : , with enterprise number: 1-65535 (https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers) su…
site_setting_ssh_keys
array
When limitsshaccess = true in Org Setting, list of SSH public keys provided by Mist Support to install onto APs (see Org:Setting)
switch_port_usage_duplex
string
Only if mode!=dynamic. Link connection mode. enum: auto, full, half
account_oauth_info_account
object
OAuth linked apps account info
32 properties
ap_radio_band5
object
5 GHz radio settings for an access point
12 properties
ospf_areas
object
Junos OSPF areas. Property key is the OSPF Area (Area should be a number (0-255) / IP address)
synthetictest_config_vlans
array
Deprecated VLAN-based synthetic test configurations
sle_thresholds
object
Site SLE threshold overrides for capacity, coverage, throughput, and time to connect
4 properties
remote_syslog_archive_files
Number of archived syslog files to retain
gw_routing_policy_term_action_export_communities
array
Optional when used as an export policy. BGP communities that may be exported
dhcpd_config_fixed_bindings
object
If type==local or type6==local. Property key is the client MAC address. Format is [0-9a-f]{12} (e.g. "5684dae9ac8b")
snmp_vacm_access_item_prefix_list_item_level
string
enum: authentication, none, privacy
switch_networks
object
Property key is network name
tunnel_config_enc_algo
stringnull
enum: 3des, aes128, aes256, aesgcm128, aesgcm256
ap_port_config_dynamic_vlan
object
Dynamic VLAN assignment settings for AP port authentication
4 properties
snmp_vacm_access_item_prefix_list
array
Context prefix rules for a VACM access entry
gateway_port_vlan_id_with_variable
If WAN interface is on a VLAN. Can be the VLAN ID (i.e. "10") or a Variable (i.e. "{{myvar}}")
sw_routing_policy
object
Switch routing policy made of ordered match-action terms
1 property
gateway_port_config_ip_config
object
Junos IP configuration for a gateway port interface
14 properties
switch_port_mirroring_egress_port_ids
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
simple_alert
object
Heuristic alert thresholds used when a Marvis subscription is unavailable
3 properties
dhcpd_config_dns_servers
array
If type==local or type6==local - optional, if not defined, system one will be used
switch_matching_rule_oob_ip_config
object
Out-of-Band Management interface configuration
3 properties
snmpv3_config
object
SNMPv3 notification, target, USM, and VACM configuration
6 properties
routing_policy_local_preference
Optional, for an import policy, localpreference can be changed, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}})
account_oauth_info_account_regions
object
For Prisma accounts only, property key is the region name. Regions with allocated bandwidth
snmpv3_config_target_address
array
SNMPv3 notification target addresses
bgp_local_as
Required if via==lan, via==tunnel or via==wan. BGP AS, value in range 1-4294967295
site_setting_config_push_policy
object
Mist also uses some heuristic rules to prevent destructive configs from being pushed
2 properties
protect_re_allowed_service
string
Services allowed through protect-RE filters. enum: icmp, ssh
gateway_wan_ppoe_auth
string
if type==pppoe. enum: chap, none, pap
switch_port_mirroring_ingress_networks
array
At least one of the inputportidsingress, inputportidsegress or inputnetworksingress should be specified
mxcluster_radsec_auth_server_ssids
array
List of ssids that will use this server if matchssid is true and match is found
ospf_area_network_auth_type
string
auth type. enum: md5, none, password
acl_policy
object
ACL Policy: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source or destinatio…
3 properties
ap_radio
object
Radio configuration settings for an access point
15 properties
radio_band_channels
arraynull
For RFTemplates. List of channels, null or empty array means auto
mxedge_das
object
Cloud-assisted Dynamic Authorization Service settings for a Mist Edge cluster
2 properties
tunnel_config_auto_provision_lat_lng
object
Geographic coordinate override for tunnel POP selection
2 properties
2 required
bgp_config_via
string
enum: lan, tunnel, vpn, wan
app_probing_custom_app_hostname
array
If protocol==http. HTTP hostnames or URLs probed by the custom app
snmp_config_trap_group_targets
array
Trap target addresses for an SNMP trap group
snmpv3_config_notify_filter_item_contents
array
OID filter rules in an SNMPv3 notification filter profile
service_policies
array
Service policies returned by derived site configuration
juniper_srx_auto_upgrade_custom_versions
object
Property key is the SRX Hardware model (e.g. "SRX4600")
site_rogue_whitelisted_bssids
array
BSSID values or wildcard patterns excluded from rogue detection
network_internet_access
object
Direct internet access settings for an organization network
5 properties
app_probing_custom_app
object
User-defined application probe definition
10 properties
modified_time
number
When the object has been modified for the last time, in epoch
vars
object
Dictionary of name-value, the vars can then be used in Wlans. This can overwrite those from Site Vars
idp_config
object
Intrusion detection and prevention settings for a service policy
4 properties
remote_syslog_archive
object
Syslog file archive retention settings
2 properties
tunnel_config_ike_proposals
array
If provider==custom-ipsec, IKE proposals used for custom IPsec negotiation
mxtunnel_vlan_ids
array
List of VLAN IDs carried by this Mist Tunnel
dhcp_snooping_networks
array
If allnetworks==false, list of network with DHCP snooping enabled
switch_bgp_config_hold_time_integer
integer
BGP hold time value from 3 to 65535 seconds
snmpv3_config_notify_type
string
Delivery mode for this SNMPv3 notification, such as trap or inform. enum: inform, trap
setting_ssr_auto_upgrade
object
Automatic firmware upgrade settings applied when an SSR device is first onboarded
4 properties
mxcluster_radsec_proxy_hosts
array
Hostnames or IPs for Mist AP to use as the TLS Server (i.e. they are reachable from AP) in addition to tuntermhosts
snmp_config_views
array
SNMP MIB view definitions
gw_routing_policy_term_action_exclude_community
array
BGP communities excluded by a gateway routing policy term
snmpv3_config_target_param
object
SNMPv3 target parameter profile
6 properties
snmp_usms
array
SNMPv3 USM engine configurations
gateway_port_vpn_path_role
string
If the VPN type==hubspoke, enum: hub, spoke. If the VPN type==mesh, enum: mesh
mxcluster_nac_client_vendor
string
convention to be followed is : " - ", could be an os/platform/model/company. For ex: for cisco vendor, there could variants wrt os (such as ios, nxos etc), pla…
radio_band_antenna_beam_pattern
string
enum: narrow, medium, wide
poe_priority
string
PoE priority. enum: low, high
site_setting_auto_upgrade_esl
object
Automatic AP ESL firmware upgrade policy. When both firmware and ESL auto-upgrade are enabled, ESL upgrade will be done only after firmware upgrade
6 properties
tunnel_config_ike_dh_group
string
Diffie-Hellman group for IKE phase 1. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5. 14 is the default 2048-bit group; 19, 20, 21, and 24 are ECP groups
ble_config_power_mode
string
Transmit power mode for BLE beacons; use custom to set explicit power. enum: custom, default
dhcpd_config_servers
array
If type==relay, upstream IPv4 DHCP servers
site_setting_critical_url_monitoring_monitor
object
Critical URL monitor definition for site health
2 properties
site_setting_vrrp_groups
object
Property key is the vrrp group
setting_ssr
object
SSR management settings for device onboarding and connectivity
5 properties
wan_extra_routes6
object
Additional IPv6 route for a WAN interface
1 property
mxcluster_nac_client_ips
object
Mist NAC client settings keyed by RADIUS client IP address or subnet
snmp_usm
object
SNMPv3 User-based Security Model configuration
3 properties
tunnel_config_node_remote_ids
array
Only if provider==jse-ipsec or provider==custom-ipsec
vrrp_group_auth_type
string
Authentication method used by the VRRP group. enum: md5, simple
sw_routing_policies
object
Switch routing policies keyed by routing policy name
gateway_template_type
string
Gateway template deployment type. enum: spoke, standalone
switch_port_usage_dynamic_vlan_networks
array
Only if mode!=dynamic and portauth==dot1x, if dynamic vlan is used, specify the possible networks/vlans RADIUS can return
gateway_path_strategy
string
enum: ecmp, ordered, weighted
extra_routes6
object
Property key is the destination CIDR (e.g. "2a02:1234:420a:10c9::/64")
snmp_vacm_security_to_group_content
array
VACM security-name to group mapping entries
gateway_vrf_instances
object
Property key is the VRF instance name
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
switch_auto_upgrade_custom_versions
object
Custom version to be used. The Property Key is the switch hardware and the property value is the firmware version
network_tenant_addresses
array
IP addresses or subnets assigned to a network tenant
dot11_bandwidth5
integer
channel width for the 5GHz band. enum: 0(disabled, response only), 20, 40, 80
idp_profile_overwrites
array
IDP profile overwrite rules applied to the base profile
allow_deny
string
Policy action value that either allows or denies matching traffic. enum: allow, deny
radsec_proxy_hosts
array
Default is site.mxedge.radsec.proxyhosts which must be a superset of all wlans[].radsec.proxyhosts. When radsec.proxyhosts are not used, tunnel peers (org or s…
auto_preemption
object
Schedule to preempt AP tunnels that are not connected to their preferred peer
3 properties
wired_port_config
object
Property key is the port name or range (e.g. "ge-0/0/0-10")
mxedge_das_coa_server
object
CoA or Disconnect-Message client allowed to contact Mist Edge DAS
6 properties
site_mxtunnel_additional_mxtunnels
object
Additional named Mist Tunnel definitions keyed by tunnel name
tunnel_config_ike_proposal
object
IKE proposal settings for custom IPsec tunnels
3 properties
site_setting_srx_app
object
Juniper SRX application visibility settings for the site
1 property
radsec_servers
array
External RadSec servers. Only if not Mist Edge.
switch_network
object
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 late…
7 properties
1 required
site_setting_paloalto_network_gateway
object
Palo Alto Networks gateway API connection settings
2 properties
gateway_port_lte_auth
string
if wantype==lte. enum: chap, none, pap
gw_routing_policy_term
object
Gateway routing policy term with match criteria and actions
2 properties
site_mxtunnel_hosts
array
Tunnel peer hostnames or IP addresses reachable from APs
site_setting_wan_vna
object
WAN Virtual Network Assistant settings for the site
1 property
gw_routing_policy_term_matching
object
Route match criteria for a gateway routing policy term; all specified criteria must match
9 properties
mxcluster_radsec_acct_servers
array
List of RADIUS accounting servers, optional, order matters where the first one is treated as primary
dhcpd_config_type6
string
enum: local (DHCP Server), none, relay (DHCP Relay)
ibeacon_major
integernull
Major number for iBeacon
mxedge_mgmt
object
Management settings for a Mist Edge appliance
6 properties
site_setting_ap_synthetic_test
object
AP Synthetic Test configuration
1 property
tunnel_provider_options_zscaler_sub_location
object
Zscaler sub-location settings for a specific network
14 properties
site_setting_analytic
object
Advanced analytics feature settings for a site
1 property
switch_matching_rule
object
Property key defines the type of matching, value is the string to match. e.g: matchname[0:3]: switch name must match the first 3 letters of the property value…
9 properties
iotproxy_visionline
object
Visionline integration settings for IoT proxy
7 properties
site_zone_occupancy_alert
object
Zone occupancy alert settings for a site
3 properties
gateway_wan_probe_override
object
Only if usage==wan. WAN health probe override for this gateway port
3 properties
gateway_path_preferences_path_target_ips
array
Destination IP addresses to replace when type==local
synthetictest_config_custom_probes
object
Custom probes to be used for synthetic tests
remote_syslog_user
object
User-specific syslog logging rule
3 properties
dhcpd_config_fixed_binding
object
Static DHCP binding for a client MAC address
3 properties
site_zone_occupancy_alert_email_notifiers
array
List of email addresses to send email notifications when the alert threshold is reached
synthetictest_config_lan_networks
array
List of networks to be used for synthetic tests
mxtunnel_protocol
string
Encapsulation protocol used for Mist Tunnel traffic. enum: ip, udp
acl_tag_specs
array
If type==resource, type==radiusgroup, type==portusage or type==gbpresource. Empty means unrestricted, i.e. any
sw_routing_policy_term_matching_protocol
array
Routing protocols that can match a switch routing policy term
remote_syslog_severity
string
enum: alert, any, critical, emergency, error, info, notice, warning
snmp_usm_user_encryption_type
string
enum: privacy-3des, privacy-aes128, privacy-des, privacy-none
junos_port_config_speed
string
enum: 100m, 10m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g,auto
tacacs_acct_server
object
TACACS+ accounting server settings
4 properties
evpn_options_vs_instances
object
Optional, for EX9200 only to segregate virtual-switches
oauth_account_errors
array
Read-only OAuth account error messages
switch_port_mirroring
object
Property key is the port mirroring instance name. portmirroring can be added under device/site settings. It takes interface and ports as input for ingress, int…
site_setting_auto_placement
object
Automatically determined AP placement coordinates and orientation
3 properties
app_probing_custom_app_protocol
string
Probe protocol for a custom application. enum: http, icmp
vrf_config
object
VRF enablement settings applied when supported on the device
1 property
tacacs_acct_servers
array
List of TACACS+ accounting servers
zscaler_sub_locations
array
sub-locations can be used for specific uses cases to define different configuration based on the user network
tunnel_config_node_internal_ips
array
Only if provider==zscaler-gre, provider==jse-ipsec, provider==custom-ipsec or provider==custom-gre
ap_port_config_mac_auth_protocol
string
if enablemacauth==true, allows user to select an authentication protocol. enum: eap-md5, eap-peap, pap
evpn_options_overlay
object
EVPN overlay BGP settings
1 property
network
object
Organization-level Layer 3 network definition that can be merged into site settings and used for service routes. Networks are used to define the service routes…
18 properties
1 required
site_wifi
object
Wi-Fi configuration settings for a site
14 properties
site_setting_status_portal_hostnames
array
Hostnames served by the site status portal
snmp_config_client_lists
array
SNMP client allowlists that can be referenced by communities
idp_profile_matching_attack_name
array
IDP attack signature names matched by an overwrite rule
gateway_template
object
Gateway Template is applied to a site for gateway(s) in a site.
32 properties
1 required
tacacs_default_role
string
enum: admin, helpdesk, none, read
site_mxtunnel_radsec_auth_servers
array
RADIUS authentication servers used by the site Mist Tunnel RadSec proxy
snmp_config
object
SNMP configuration for managed network devices
13 properties
gateway_wan_probe_override_probe_profile
string
WAN probe profile used for health checks on this port. enum: broadband, lte
tunnel_config_auto_provision
object
Auto-provisioning configuration for the tunnel. This takes precedence over the primary and secondary nodes.
7 properties
1 required
dhcpd_config
object
DHCP server configuration map with a global enable flag
1 property
sw_routing_policy_term_matching
object
Route match criteria for a switch routing policy term; all specified criteria must match
4 properties
network_template
object
Network template configuration applied to sites or site groups
30 properties
dhcpd_config_option_type
string
enum: boolean, hex, int16, int32, ip, string, uint16, uint32
snmp_config_v2c_config
object
SNMPv2c community configuration entry
4 properties
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
ble_config_beacon_rate_mode
string
Beacon rate mode for Mist BLE beacons; use custom to set beaconrate. enum: custom, default
tunnel_config_node
object
Only if provider==zscaler-ipsec, provider==jse-ipsec or provider==custom-ipsec
5 properties
2 required
network_multicast
object
Whether to enable multicast support (only PIM-sparse mode is supported)
3 properties
gateway_port_vpn_paths
object
Property key is the VPN name
snmp_config_engine_id
string
SNMP engine ID value used for SNMPv3
response_http429
object
Standard HTTP 429 rate limit error response
1 property
dns_servers
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
id
string
Unique ID of the object instance in the Mist Organization
switch_matching_rule_ip_config
object
In-Band Management interface configuration
2 properties
snmpv3_config_notify_filter_item_content
object
OID filter rule for an SNMPv3 notification profile
2 properties
simple_alert_arp_failure
object
Thresholds for ARP failure heuristic alerts
3 properties
ap_port_config_dynamic_vlan_type
string
Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS.\ \ enum: airespace-interface-name, where the VLAN is determined by parsing\ \ the RAD…
site_setting_ap_port_config
object
AP Ethernet port configuration overrides by model
1 property
protect_re
object
Restrict inbound-traffic to host when enabled, all traffic that is not essential to our operation will be dropped e.g. ntp / dns / traffic to mist will be allo…
5 properties
synthetictest_config_vlan_custom_test_urls
array
Deprecated custom URLs tested by VLAN-based synthetic probes
remote_syslog_cacerts
array
CA certificates used to verify TLS syslog servers
network_internal_access
object
Internal access settings for an organization network
1 property
service_policy_ssl_proxy
object
SRX SSL proxy inspection settings for a service policy
2 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
dhcpd_config_vendor_option_type
string
enum: boolean, hex, int16, int32, ip, string, uint16, uint32
gateway_wan_type6
string
enum: autoconf, dhcp, static
gw_routing_policy_term_action_add_target_vrfs
array
For SSR, target VRFs used by a hub when leaking VRF routes to spokes
mxcluster_nac
object
Mist NAC RADIUS settings for a Mist Edge cluster. Used when the Mist Edge Cluster is used as a RADIUS Proxy between the local devices and the Mist NAC
5 properties
switch_port_usage_dynamic_rule_equals_any
array
Use equalsany to match any item in a list
dhcpd_config_servers6
array
If type6==relay, upstream IPv6 DHCP servers
snmpv3_config_notify_filter_item
object
SNMPv3 notification filter profile
2 properties
gateway_port_usage
string
port usage name. enum: hacontrol, hadata, lan, wan
switch_port_usage_mode
string
mode==dynamic must only be used if the port usage name is dynamic. enum: access, dynamic, inet, trunk
hours
object
Day-of-week operating hour filters using hour ranges such as 09:00-17:00
7 properties
switch_port_usage_networks
array
Only if mode==trunk, the list of network/vlans
network_vpn_access_static_nat
object
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}}")
tunnel_config_networks
array
If provider==custom-ipsec or provider==prisma-ipsec, networks reachable via this tunnel
gateway_mgmt_probe_hosts
array
IPv4 probe hosts used for gateway connectivity checks
remote_syslog_contents
array
List of syslog content selectors
response_http404
object
Standard HTTP 404 not found error response
1 property
tunterm_monitoring
array
Tunnel termination monitoring checks
next_hop_via
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.
site_setting_juniper_srx
object
Site-level Juniper SRX integration settings
3 properties
ap_uplink_port_config
object
AP Uplink port configuration
2 properties
gateway_ip_config_dns_servers
array
Except for out-ofband interface (vme/em0/fxp0)
gateway_port_config_reth_idx
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…
service_policy_ewf
array
Enhanced web filtering rules applied by a service policy
switch_port_usage_dynamic_reset_default_when
string
Only if mode==dynamic Control when the DPC port should be changed to the default port usage. enum: linkdown, none (let the DPC port keep at the current port us…
dhcpd_config_dns_suffix
array
If type==local or type6==local - optional, if not defined, system one will be used
gw_routing_policies
object
Property key is the routing policy name
network_vpn_access_destination_nat_property
object
VPN access destination NAT rule target settings
3 properties
network_routed_for_networks
array
For a Network (usually LAN), it can be routable to other networks (e.g. OSPF)
gw_routing_policy_term_matching_protocol
array
Routing protocols that can match a gateway routing policy term
dhcpd_config_type
string
enum: local (DHCP Server), none, relay (DHCP Relay)
snmp_vacm_security_to_group_content_item
object
VACM security-name to group mapping entry
2 properties
radius_acct_port
RADIUS Auth Port, value from 1 to 65535, default is 1813
switch_vrf_instances
object
Property key is the network name
site_setting_rtsa
object
Managed mobility and asset tracking settings
5 properties
vrrp_group
object
Junos VRRP group authentication and network settings
4 properties
site_setting_juniper_srx_gateways
array
Juniper SRX gateways integrated with a site
acl_tag_spec
object
Layer 4 protocol and destination-port match constraint for an ACL tag
2 properties
site_setting_wired_vna
object
Wired Virtual Network Assistant settings for the site
1 property
radius_coa_port
RADIUS CoA Port, value from 1 to 65535, default is 3799
gw_routing_policy_term_matching_vpn_neighbor_mac
array
Overlay neighbor MAC addresses used for bgpconfig where via==vpn
vs_instance
object
Optional, for EX9200 only to segregate virtual-switches. Property key is the instance name
ospf_areas_network
object
Property key is the network name. Networks to participate in an OSPF area
12 properties
tunnel_provider_options
object
Provider-specific options for gateway tunnel auto provisioning
3 properties
synthetictest_config_lan_network
object
configure minis probes to be tested on lan networks of gateways
2 properties
site_occupancy_analytics
object
Analytics settings for site occupancy
5 properties
gw_routing_policy_term_matching_protocol_enum
string
enum: aggregate, bgp, direct, ospf, static (SRX Only)
gateway_port_vpn_path_bfd_profile
string
Only if the VPN type==hubspoke. enum: broadband, lte
radsec_idle_timeout
RadSec idle timeout in seconds. Default is 60
site_mxtunnel_protocol
string
Encapsulation protocol used for this additional Mist Tunnel. enum: ip, udp
acl_tag_subnets
array
If - type==subnet - type==resource (optional. default is any) - type==staticgbp if from matching subnet
gateway_path_type
string
enum: local, tunnel, vpn, wan
tunnel_config_probe
object
Tunnel health probe settings
4 properties
tunterm_monitoring_protocol
string
enum: arp, ping, tcp
tunnel_config_protocol
string
Only if provider==custom-ipsec. enum: gre, ipsec
bgp_config_networks
array
Optional if via==lan. List of networks where we expect BGP neighbor to connect to/from
site_setting_vna
object
Virtual Network Assistant settings for AP, switch, and gateway experiences at a site
1 property
acl_tags
object
ACL Tags to identify traffic source or destination. Key name is the tag name
dns_suffix
array
Global dns settings. To keep compatibility, dns settings in ipconfig and oobipconfig will overwrite this setting
site_setting_ap_matching
object
Rules for applying AP port configuration by AP model or name
2 properties
gateway_oob_ip_config_node1
object
Node1-specific out-of-band management IP configuration for HA clusters
7 properties
config_switch_local_accounts_user_role
string
enum: admin, helpdesk, none, read
account_oauth_info_account_service_connections
For Prisma accounts only, property key is the service connection name
tacacs_auth_servers
array
List of TACACS+ authentication servers
gateway_matching_rule
object
Gateway matching rule that applies settings when its match keys select a gateway
3 properties
service_policy_skyatp_http_inspection_profile
string
Sky ATP HTTP inspection profile to apply. enum: standard, strict
tunnel_config_auto_provision_provider
string
Tunnel provider used for automatic endpoint provisioning. enum: jse-ipsec, zscaler-ipsec
site_engagement
object
Engagement analytics dwell-time rules for classifying site visits. If hours is omitted, rules apply every day from 00:00 to 23:59. Multiple ranges for the same…
5 properties
site_mxtunnel_additional_mxtunnel_vlan_ids
array
VLAN IDs carried by an additional site Mist Tunnel
site_setting_paloalto_networks
object
Palo Alto Networks integration settings for the site
2 properties
site_mxtunnel_additional_mxtunnel_clusters
array
Tunnel peer cluster definitions APs use for an additional Mist Tunnel
site_mxtunnel_cluster_tunterm_hosts
array
Tunnel termination hostnames or IP addresses in a site Mist Tunnel cluster
push_policy_push_window
object
If enabled, new config will only be pushed to device within the specified time window
2 properties
network_vpn_access_destination_nat
object
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.1…
site_mxtunnel_radsec
object
RadSec proxy settings for a site Mist Tunnel
4 properties
gw_routing_policy_term_action_add_community
array
BGP communities added to routes matched by a gateway routing policy term
ap_port_config_port_auth
string
When doing port auth. enum: dot1x, none
remote_syslog_server
object
Remote syslog server destination settings
13 properties
gw_routing_policy_term_matching_vpn_path
array
Overlay path names used for bgpconfig where via==vpn; order is significant
tunnel_config_node_wan_names
array
Interface names that source tunnel traffic for a tunnel node
acl_policy_actions
array
ACL Policy Actions: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source or de…
network_vpn_access_config_other_vrfs
array
By default, the routes are only readvertised toward the same vrf on spoke. To allow it to be leaked to other vrfs
network_template_import_org_networks
array
Org Networks that we'd like to import
site_setting_tunterm_multicast_config_ssdp
object
SSDP multicast forwarding settings for tunneled VLANs
2 properties
juniper_srx_auto_upgrade
object
SRX firmware auto-upgrade settings applied when a device is first onboarded
4 properties
config_switch_local_accounts_user
object
Local switch user account credentials and access role
2 properties
sw_routing_policy_term
object
Switch routing policy term with match criteria and actions
3 properties
1 required
gateway_port_config_wan_networks
array
Only if usage==wan. If some networks are connected to this WAN port, it can be added here so policies can be defined
site_setting_derived_accounts
object
Derived OAuth account integration details keyed by account name
switch_port_usage_speed
string
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
mxcluster_nacedge_caching_site_ids
array
Site UUIDs whose auth requests are cached by NAC Edges in the cluster
protect_re_allowed_services
array
Built-in services explicitly allowed by the Protect RE policy
snmpv3_config_target_params
array
SNMPv3 target parameter profiles
site_setting_status_portal
object
End-user status portal settings for the site
2 properties
switch_port_usage_mtu
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.
mxedge_das_coa_servers
array
Dynamic authorization clients configured to send CoA|DM to mist edges on port 3799
aggregate_routes6
object
Property key is the destination subnet (e.g. "2a02:1234:420a:10c9::/64")
acl_policy_action
object
Action applied to traffic that matches a destination ACL tag
2 properties
1 required
account_oauth_info_account_service_connection
object
Prisma Access service connection region for a linked OAuth account
1 property
bgp_config_type
string
Required if via==lan, via==tunnel or via==wan. enum: external, internal
acl_tag_type
string
enum: any: matching anything not identified dynamicgbp: from the gbptag received from RADIUS gbpresource: can only be used in dsttags mac network portusage rad…
tunnel_config_dh_group
string
Only if provider==custom-ipsec. Diffie-Hellman group for IPsec phase 2. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5. 14 is the default 2048-bit group; 19, 20, 21…
gateway_port_dsl_type
string
if wantype==dsl. enum: adsl, vdsl
gateway_mgmt_admin_sshkeys
array
For SSR only, as direct root access is not allowed
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
radius_config
object
Junos RADIUS authentication and accounting configuration
9 properties
tunnel_config_ipsec_proposal
object
IPsec proposal settings for custom IPsec tunnels
3 properties
vars_annotation
object
Annotation for a single var, helping identify its purpose and enabling auto-complete/enumeration in UI
2 properties
wlan_mist_nac
object
Mist NAC RADIUS settings for a WLAN
9 properties
tunnel_config_auto_provision_node
object
Auto-provisioned tunnel endpoint settings
2 properties
snmp_config_trap_version
string
enum: all, v1, v2
tunnel_config_ike_mode
string
Only if provider==custom-ipsec. enum: aggressive, main
service_policy_ewf_rule
object
Enhanced web filtering rule applied by a service policy
4 properties
radius_auth_servers
array
List of RADIUS authentication servers
sw_routing_policy_terms
array
Ordered switch routing policy terms; at least one term is required
gateway_port_wan_arp_policer
string
Only when wantype==broadband. enum: default, max, recommended
additional_config_cmds
array
additional CLI commands to append to the generated Junos config. Note: no check is done
remote_syslog_console
object
Console log forwarding filters for remote syslog
1 property
gateway_matching_rules
array
Gateway matching rules used by a gateway matching configuration
mist_nacedge
object
Mist NAC Site Survivability settings for the site
6 properties
additional_vlan_ids
List or Comma separated list of additional VLAN IDs (on the LAN side or from other WLANs) should we be forwarding bonjour queries/responses
service_policy_skyatp_dns_dga_detection
object
Sky ATP DNS DGA detection settings
2 properties
network_internet_access_static_nat_property
object
Direct-internet static NAT rule target settings
3 properties
remote_syslog_file_config
object
Generated syslog file output settings
7 properties
snmp_vacm_access_item_prefix_list_item_model
string
enum: any, usm, v1, v2c
snmpv3_config_notify
array
SNMPv3 notification definitions used for traps and informs
vs_instance_property
object
EX9200 virtual-switch instance settings
1 property
network_vpn_access
object
Property key is the VPN name. Whether this network can be accessed from vpn
mxcluster_radsec_nas_ip_source
string
SSpecify NAS-IP-ADDRESS, NAS-IPv6-ADDRESS to use with authservers. enum: any, oob, oob6, tunnel, tunnel6
response_http401
object
Standard HTTP 401 authentication error response
1 property
synthetictest_config
object
Synthetic test configuration for Marvis Minis
6 properties
tacacs
object
TACACS+ settings for switch management authentication and accounting
5 properties
site_engagement_dwell_tag_names
object
Display labels for engagement dwell-time categories
4 properties
site_setting_auto_upgrade
object
Automatic AP firmware upgrade policy
5 properties
synthetictest_config_vlan_vlan_ids
array
VLAN identifiers where deprecated VLAN-based synthetic probes run
service_policy_skyatp_http_inspection
object
Sky ATP HTTP inspection settings
2 properties
remote_syslog_files
array
Generated syslog file output definitions
idp_profile
object
Organization IDP profile with a base profile and targeted overwrite rules
7 properties
dot11_bandwidth6
integer
channel width for the 6GHz band. enum: 0(disabled, response only), 20, 40, 80, 160
vlan_ids
array
list of VLAN IDs on which rogue APs are ignored
snmpv3_config_target_param_mess_process_model
string
enum: v1, v2c, v3
radius_acct_servers
array
List of RADIUS accounting servers
gateway_traffic_shaping_class_percentages
array
percentages for different class of traffic: high / medium / low / best-effort. Sum must be equal to 100
switch_bgp_config_networks
array
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.
gateway_port_wan_type
string
Only if usage==wan. enum: broadband, dsl, lte
gw_routing_policy_term_action_exclude_as_path
array
Optional when used as an export policy. AS path values to exclude
ble_config_beam_disabled
array
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…
app_probing_custom_apps
array
User-defined application probe definitions
acl_policy_src_tags
array
ACL Policy Source Tags: - for GBP-based policy, all srctags and dsttags have to be gbp-based - for ACL-based policy, network is required in either the source o…
site_rogue_whitelisted_ssids
array
SSID names excluded from rogue detection
snmp_usm_users
array
SNMPv3 USM user definitions
switch_vrf_instance
object
Switch VRF instance routing and network membership settings
7 properties
protect_re_customs
array
Custom Protect RE ACL entries
tunnel_config_local_subnets
array
List of Local protected subnet for policy-based IPSec negotiation
antenna_select
string
Antenna Mode for AP which supports selectable antennas. enum: "" (default), external, internal
radius_keywrap_format
string
Encoding format for RADIUS keywrap KEK and MACK values. enum: ascii, hex
protect_re_custom_protocol
string
enum: any, icmp, tcp, udp
ble_config
object
Bluetooth Low Energy beacon and asset advertising settings for an AP
27 properties
site_wifi_proxy_arp
stringnull
enum: default, disabled, enabled
tunnel_provider_options_prisma
object
Prisma Access provider options for tunnel auto provisioning
1 property
acl_tag
object
Resource tags (type==resource or type==gbpresource) can only be used in dsttags
9 properties
1 required
synthetictest_config_lan_networks_networks
array
List of networks to be used for synthetic tests
app_probing_apps
array
Application keys from [List Applications](/operations/listApplications)
mxcluster_rad_auth_server_keywrap_format
stringnull
if used for Mist APs. enum: ascii, hex
site_id
string
Unique identifier of a Mist site
networks
array
List of organization network definitions
protect_re_custom
object
Custom Protect RE ACL entry
3 properties
synthetictest_config_wan_speedtest
object
WAN speedtest scheduling settings for synthetic tests
2 properties
marvis_auto_operations
object
Marvis automatic remediation operation toggles
9 properties
gateway_ip_config_dns_suffix
array
Except for out-ofband interface (vme/em0/fxp0)
gw_routing_policy_term_matching_vpn_path_sla
object
SLA thresholds used when matching VPN paths
3 properties
evpn_options
object
EVPN topology generation options for campus fabric configuration
13 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mist 12
Other APIs Mist publishes across the network.
Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
#Sites Setting
Where this information came from
This is an independent, third-party profile of Mist Sites Setting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.