How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Networks 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.

Juniper Networks Sites Setting API is one of 263 APIs that Juniper Networks 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, an API reference, API documentation, a getting-started guide, and rate-limit docs.

This API exposes 9 operations across 5 paths, and defines 421 schemas. It is described by OpenAPI 3.2.0, at version 2607.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 421 schemas 3 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2607.1.1
Base URL
netconf://[device-ip]:830
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Juniper Networks 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]($e/Admins%20Login/login) request, Mist returns a csrftoken cookie.…

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
getSiteSetting 1 param → 200400401403404429
PUT
/api/v1/sites/{site_id}/setting
updateSiteSettings
updateSiteSettings 1 param body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/setting/blacklist
deleteSiteWirelessClientsBlocklist
deleteSiteWirelessClientsBlocklist 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/setting/blacklist
createSiteWirelessClientsBlocklist
createSiteWirelessClientsBlocklist 1 param body → 200400401403404429
GET
/api/v1/sites/{site_id}/setting/derived
getSiteSettingDerived
getSiteSettingDerived 1 param → 200400401403404429
DELETE
/api/v1/sites/{site_id}/setting/watched_station
deleteSiteWatchedStations
deleteSiteWatchedStations 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/setting/watched_station
createSiteWatchedStations
createSiteWatchedStations 1 param body → 200400401403404429
DELETE
/api/v1/sites/{site_id}/setting/whitelist
deleteSiteWirelessClientsAllowlist
deleteSiteWirelessClientsAllowlist 1 param → 200400401403404429
POST
/api/v1/sites/{site_id}/setting/whitelist
createSiteWirelessClientsAllowlist
createSiteWirelessClientsAllowlist 1 param body → 200400401403404429

Schemas 421

The contract defines 421 schemas that model the data the API accepts and returns. The most detailed are site_setting_derived (134 properties), site_setting (102 properties), gateway_port_config (48 properties), switch_port_usage (46 properties). Each schema is shown below with its type and property counts.

service_policy_skyatp_dns_dga_detection_profile2
string
Sky ATP DNS DGA detection profile to apply. enum: default, standard, strict.
allow_deny2
string
Allow or deny action for traffic matched by this service policy
switch_bgp_config_neighbor
object
Per-neighbor switch BGP session settings
5 properties 1 required
tunnel_config_version2
string
Only if provider==custom-gre or provider==custom-ipsec. Tunnel version value for custom tunnel configuration. enum: 1, 2.
mxedge_mgmt_oob_ip_type2
string
IPv4 address assignment mode for out-of-band management. enum: dhcp, disabled, static.
app_probing_custom_app
object
User-defined application probe definition
10 properties
network_multicast_group
object
Multicast group rendezvous point mapping
1 property
switch_port_usage_storm_control2
object
Only if mode!=dynamic. Storm-control settings for this port usage
6 properties
tacacs_acct_server
object
TACACS+ accounting server settings
4 properties
ble_config3
object
Bluetooth Low Energy configuration applied to APs at the site
27 properties
switch_port_usage_duplex2
string
Only if mode!=dynamic. Link duplex mode for this port usage. enum: auto, full, half.
response_http403
object
Standard HTTP 403 permission error response
1 property
tunnel_config_enc_algo3
string
Cipher algorithm used by this IKE proposal. enum: 3des, aes128, aes256, aesgcm128, aesgcm256.
snmpv3_config_target_param_mess_process_model2
string
SNMP message processing model used by this target parameter profile. enum: v1, v2c, v3.
gateway_path_preferences
object
Gateway path preference that selects among one or more local, WAN, VPN, or tunnel paths
2 properties
gateway_wan_type62
string
IPv6 assignment mode for this gateway port interface. enum: autoconf, dhcp, static.
site_mxtunnel_cluster
object
Mist Tunnel peer cluster definition for a site
2 properties
network_vpn_access_config
object
VPN access settings for a network and VPN pair
14 properties
switch_matching_rule_ip_config2
object
In-band management IP configuration applied when this matching rule matches
2 properties
site_setting_ap_matching2
object
Rules that apply model-specific AP port configuration
2 properties
snmp_usm_user
object
SNMPv3 USM user definition
5 properties
remote_syslog_archive3
object
Retention settings for generated syslog archive files
2 properties
remote_syslog_time_format2
string
Timestamp format used in forwarded syslog messages. enum: millisecond, year, year millisecond.
tunnel_provider_options2
object
Provider-specific tunnel options defined by this gateway template
3 properties
ap_radio_band62
object
6 GHz radio settings for this access point
13 properties
switch_matching1
object
Rules for matching switches to model-specific settings
2 properties
ssr_upgrade_channel4
string
Firmware release channel used for SSR auto-upgrade. enum: alpha, beta, stable.
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…
4 properties
remote_syslog_severity1
string
Default syslog severity for messages sent to this server. enum: alert, any, critical, emergency, error, info, notice, warning.
gateway_mgmt2
object
Management-plane defaults provided by this gateway template
16 properties
junos_port_config
object
Junos switch port configuration
19 properties 1 required
iotproxy_visionline2
object
Site access-control integration settings for Visionline
7 properties
radio_band_preamble2
string
802.11 preamble mode used by the 6 GHz radio. enum: auto, long, short.
dot11_bandwidth62
integer
Channel width configured for the 6 GHz radio. enum: 0, 20, 40, 80, 160.
tunnel_config_protocol2
string
Only if provider==custom-ipsec. Tunnel protocol for custom tunnel negotiation. enum: gre, ipsec.
site_setting_paloalto_network_gateway
object
Palo Alto Networks gateway API connection settings
2 properties
config_switch_local_accounts_user_role2
string
Access role granted to the local switch user account. enum: admin, helpdesk, none, read.
switch_radius_config3
object
RADIUS authentication and accounting defaults in this network template
12 properties
switch_port_usage_speed2
string
Only if mode!=dynamic. Link speed for this port usage. enum: 10m, 100m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g, auto.
ip_type4
string
IPv4 address assignment mode for this gateway network interface. enum: dhcp, static.
gw_routing_policy_term_matching_vpn_path_sla2
object
SLA thresholds used when matching a VPN path
3 properties
radio_band_preamble4
string
802.11 preamble mode used by the 2.4 GHz radio. enum: auto, long, short.
idp_config2
object
Intrusion detection and prevention settings applied by this service policy
4 properties
bgp_config_type2
string
Required if via==lan, via==tunnel or via==wan; BGP session type, internal or external
tunnel_config_node3
object
Main remote tunnel endpoint settings
9 properties 2 required
switch_auto_upgrade1
object
Switch firmware auto-upgrade configuration
3 properties
radio_band_preamble1
string
802.11 preamble mode used by the 5 GHz radio. enum: auto, long, short.
idp_profile_overwrite
object
Override rule that changes the IDP action for matching signatures
3 properties
site_setting_rtsa2
object
Managed mobility and asset tracking settings for the site
5 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
site_mxtunnel1
object
Site Mist Tunnel configuration
18 properties
site_setting_auto_placement2
object
Automatic AP placement settings for the site
3 properties
system_defined_port_usages
string
system-default port usages. enum: ap, iot, uplink
account_oauth_info_account
object
OAuth linked apps account info
32 properties
switch_matching_rule_oob_ip_config2
object
Out-of-band management IP configuration applied when this matching rule matches
3 properties
wlan_mist_nac3
object
Juniper Mist NAC settings used by AP port authentication
9 properties
dhcpd_config_fixed_binding
object
Static DHCP binding for a client MAC address
3 properties
push_policy_push_window1
object
Allowed time window during which configuration pushes may run
2 properties
site_engagement1
object
Dwell-time analytics rules for the site
5 properties
gateway_port_config
object
Gateway port configuration for LAN, WAN, tunnel, and HA interfaces
48 properties 1 required
gateway_port_wan_source_nat2
object
Source NAT settings applied to traffic leaving this WAN port
3 properties
extra_route_next_qualified_properties
object
Qualified next-hop attributes for an IPv4 static route
2 properties
vrf_extra_route6
object
Additional IPv6 static route for a VRF instance
1 property
radsec_server
object
External RadSec server settings
2 properties
switch_vrf_instance
object
Switch VRF instance routing and network membership settings
8 properties
snmp_config_view
object
SNMP MIB view definition
3 properties
mac_addresses
object
Request containing one or more MAC addresses
1 property 1 required
radio_band_antenna_mode4
string
Radio chain mode for the 2.4 GHz radio. enum: 1x1, 2x2, 3x3, 4x4, default.
service_policy_skyatp_dns_tunnel_detection2
object
Detection settings for DNS tunneling threats provided by Sky ATP
2 properties
auto_preemption1
object
Preemption behavior for restoring preferred tunnel peers after failover
3 properties
gateway_port_dsl_type2
string
If wantype==dsl. DSL technology used by the WAN port. enum: adsl, vdsl.
service_policy_secintel3
object
Threat intelligence settings applied by this service policy
3 properties
snmpv3_config_notify_filter_item_content
object
OID filter rule for an SNMPv3 notification profile
2 properties
site_occupancy_analytics
object
Analytics settings for site occupancy
5 properties
remote_syslog_server
object
Remote syslog server destination settings
13 properties
poe_priority3
string
Only if mode!=dynamic. PoE priority for ports using this port usage. enum: low, high.
dhcpd_config_property
object
DHCP server or relay configuration for one network
16 properties
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
site_setting_skyatp2
object
Threat intelligence settings from Sky ATP for the site
2 properties
ap_radio_antenna_mode2
string
Selected radio chain mode for AP models that support antenna mode control. enum: 1x1, 2x2, 3x3, 4x4, default.
ap_port_config_port_auth2
string
Authentication mode for this AP Ethernet port. enum: dot1x, none.
ap_port_config_dynamic_vlan_type2
string
Mapping mode for interpreting dynamic VLAN attributes returned by RADIUS. enum: airespace-interface-name, standard.
mist_nacedge1
object
NAC Edge service settings for the site Mist Edge cluster
6 properties
tunnel_config_auth_algo1
string
Integrity algorithm used by this IPsec proposal. enum: md5, sha1, sha2.
remote_syslog_content
object
Syslog message content selector for remote logging
2 properties
service_policy_syslog2
object
Remote logging settings applied by this service policy
2 properties
acl_policy_action
object
Action applied to traffic that matches a destination ACL tag
2 properties 1 required
switch_radius_config4
object
Switch RADIUS configuration for the site
12 properties
setting_ssr_auto_upgrade2
object
Automatic SSR firmware upgrade settings for newly onboarded devices
4 properties
switch_stp_config2
object
Spanning Tree Protocol configuration applied when this matching rule matches
1 property
setting_ssr2
object
Session Smart Router settings for the site
5 properties
tunnel_config_enc_algo1
string
Cipher algorithm used by this IPsec proposal. enum: 3des, aes128, aes256, aesgcm128, aesgcm256.
tunnel_via2
string
If via==tunnel, primary or secondary tunnel associated with this BGP neighbor
site_setting_auto_upgrade_esl2
object
Automatic ESL firmware upgrade settings for the site
6 properties
site_setting_juniper_srx2
object
SRX integration settings for the site
3 properties
snmpv3_config_target_param_security_model2
string
Required security model for this target parameter profile. enum: usm, v1, v2c.
snmp_config_trap_group
object
SNMP trap group definition
4 properties
gateway_wan_probe_override2
object
Optional WAN health probe override settings for this port
5 properties
gateway_ip_config_property
object
Gateway network interface IP configuration
7 properties
gateway_wan_probe_override_http2
object
HTTP probe settings; success from any ICMP or HTTP probe indicates the WAN is up
2 properties
ospf_areas_network
object
Property key is the network name. Networks to participate in an OSPF area
12 properties
service_policy_ewf_rule_profile2
string
Enhanced web filtering profile applied by this rule. enum: critical, standard, strict.
snmp_vacm_security_model2
string
Required security model for these VACM group mappings. enum: usm, v1, v2c.
switch_multicast_config3
object
Multicast configuration for this VRF instance. PIM is automatically enabled when any network in this VRF has multicast.enabled==true
4 properties
network_vpn_access_static_nat_property
object
VPN access static NAT rule target settings
2 properties
ssr_proxy2
object
Network proxy settings used by SSR devices to reach Mist
2 properties
gateway_vrf_instance
object
Gateway VRF instance and its member networks
1 property
radio_band_antenna_mode1
string
Radio chain mode for the 5 GHz radio. enum: 1x1, 2x2, 3x3, 4x4, default.
ip_type5
string
IP assignment mode for the node1 out-of-band management interface. enum: dhcp, static.
site_setting_mxedge2
object
Site Mist Edge service settings
4 properties
gw_routing_policy_term_matching2
object
Route match criteria that must be satisfied before actions are applied
9 properties
ap_led3
object
AP LED behavior configured for the site
2 properties
snmp_vacm_access_item_prefix_list_item_level2
string
Required security level for this VACM access rule. enum: authentication, none, privacy.
dhcpd_config_vendor_option
object
Vendor-encapsulated DHCP option value
2 properties
tunnel_config_ike_mode2
string
Only if provider==custom-ipsec. IKE negotiation mode for the tunnel. enum: aggressive, main.
gateway_oob_ip_config_node12
object
Out-of-band management IP configuration override for node1 in an HA cluster
7 properties
remote_syslog_facility3
string
Syslog facility to match for this selector. enum: any, authorization, change-log, config, conflict-log, daemon, dfc, external, firewall, ftp, interactive-comma…
snmpv3_config_notify_type2
string
Delivery mode for this SNMPv3 notification, such as trap or inform
gateway_template1
object
Template settings applied to site gateways
32 properties 1 required
switch_port_usage_dot1x2
string
Only if mode!=dynamic. 802.1X authentication mode for this port usage. enum: dot1x.
aggregate_route
object
Aggregate route configuration for a network or routing instance
3 properties
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
tunnel_config_auto_provision2
object
Provider auto-provisioning settings for tunnel endpoints
7 properties 1 required
ap_radio_band51
object
5 GHz settings used when the 2.4 GHz radio operates in 5 GHz mode
12 properties
allow_deny4
string
Allow or deny decision applied to traffic matching the destination tag
extra_route
object
IPv4 static route settings for a destination prefix
6 properties
mxcluster_radsec_server_selection2
string
RADIUS server selection strategy for RadSec failover. enum: ordered, unordered.
switch_bgp_config_hold_time_zero
integer
BGP hold time value of 0
synthetictest_config1
object
Active monitoring test configuration for the site
6 properties
tunnel_config_node1
object
Backup remote tunnel endpoint settings
9 properties 2 required
switch_port_usage
object
Junos switch port usage template and authentication settings
46 properties
snmp_usm_user_authentication_type2
string
Authentication protocol used by this SNMPv3 USM user. enum: authentication-md5, authentication-none, authentication-sha, authentication-sha224, authentication-…
snmp_vacm_security_to_group_content_item
object
VACM security-name to group mapping entry
2 properties
wan_extra_routes6
object
Additional IPv6 route for a WAN interface
1 property
switch_mist_nac3
object
Network access control settings for switches at the site
2 properties
vrrp_group
object
Junos VRRP group authentication and network settings
4 properties
dhcpd_config_vendor_option_type2
string
Data type used to encode this vendor option value. enum: boolean, hex, int16, int32, ip, string, uint16, uint32.
sw_routing_policy_term_matching2
object
Route match criteria that must be satisfied before actions are applied
4 properties
gw_routing_policy_term_matching_protocol_enum
string
enum: aggregate, bgp, direct, ospf, static (SRX Only)
gateway_port_vpn_path
object
VPN path settings for traffic that uses a gateway port
5 properties
vs_instance_property
object
EX9200 virtual-switch instance settings
1 property
gateway_port_wan_type2
string
Only if usage==wan. WAN uplink type configured on the port. enum: broadband, dsl, lte.
tunterm_monitoring_protocol2
string
Monitoring method used for this tunnel termination check. enum: arp, ping, tcp.
switch_mist_nac2
object
Mist NAC defaults applied by this network template
2 properties
snmp_usm_user_encryption_type2
string
Privacy protocol used by this SNMPv3 USM user. enum: privacy-3des, privacy-aes128, privacy-des, privacy-none.
snmp_config2
object
SNMP defaults provided by this network template
13 properties
dot11_bandwidth52
integer
Channel width configured for the 5 GHz radio. enum: 0, 20, 40, 80.
snmp_vacm_access_item_prefix_list_item
object
Context prefix rule for a VACM access entry
7 properties
gateway_matching_rule
object
Gateway matching rule that applies settings when its match keys select a gateway
3 properties
tacacs2
object
Management authentication settings using TACACS+
5 properties
hours1
object
Day-of-week hour ranges when configuration pushes are allowed
7 properties
gw_routing_policy_term_matching_route_exists2
object
Existing route condition that must be satisfied before this term matches
2 properties
tunnel_config_auto_provision_node3
object
Main auto-provisioned tunnel endpoint settings
2 properties
evpn_options3
object
Fabric EVPN options for the site
13 properties
hours3
object
Schedule during which engagement analytics rules apply
7 properties
protect_re_custom
object
Custom Protect RE ACL entry
3 properties
tunnel_provider_options_jse2
object
Juniper Secure Edge provisioning options for tunnel endpoints
2 properties
protect_re1
object
Control-plane protection settings for the gateway
5 properties
bgp_config_via2
string
Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
site_setting_analytic2
object
Advanced analytics configuration for the site
1 property
gateway_matching2
object
Matching rules that select gateways for this template
2 properties
site_setting_critical_url_monitoring2
object
Monitoring configuration for critical URLs at the site
2 properties
synthetictest_config_custom_probe_type3
string
Probe type used by this custom synthetic probe. enum: application, curl, icmp, reachability, tcp.
idp_profile_base_profile2
string
Built-in IDP baseline profile inherited before applying overwrites. enum: critical, standard, strict.
radio_band_24_usage4
string
Radio usage mode for the 2.4 GHz-capable radio. enum: 24, 5, 6, auto.
vrrp_group_network
object
Virtual IP assignment for a VRRP network
1 property
dhcpd_config3
object
DHCP server defaults provided by this gateway template
1 property
gateway_wan_type2
string
IPv4 assignment mode for this gateway port interface. enum: dhcp, pppoe, static.
tunnel_provider_options_prisma2
object
Palo Alto Prisma Access provisioning options for tunnel endpoints
1 property
network_multicast2
object
Settings for multicast routing on this network
3 properties
mxcluster_rad_auth_server_keywrap_format2
string
Encoding format for Mist AP RADIUS keywrap keys. enum: ascii, hex.
switch_network_multicast2
object
Multicast (IGMP snooping) settings for this VLAN
2 properties
dhcpd_config_type2
string
IPv4 DHCP mode for this network. enum: local, none, relay.
gateway_wan_ppoe_auth2
string
Authentication protocol used for PPPoE when type==pppoe. enum: chap, none, pap.
site_setting
object
Configuration settings applied at the site level
102 properties
simple_alert2
object
Threshold alert settings for the site
3 properties
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…
8 properties 1 required
snmpv3_config2
object
SNMPv3 user, VACM, notify, and target configuration
6 properties
day_of_week4
string
Weekly AP auto-upgrade day for the maintenance window. enum: any, fri, mon, sat, sun, thu, tue, wed.
sle_thresholds2
object
Service level expectation threshold settings for the site
4 properties
evpn_options_routed_at2
string
Topology tier where EVPN virtual gateway routing is placed. enum: core, distribution, edge.
site_setting_vna2
object
Virtual Network Assistant settings for the site
1 property
marvis_auto_operations2
object
Automatic remediation operations controlled by Marvis
9 properties
ssl_proxy_ciphers_category2
string
Allowed cipher strength category for SSL proxy inspection. enum: medium, strong, weak.
tunnel_provider_options_zscaler2
object
Provider settings for Zscaler tunnel endpoints
15 properties
simple_alert_arp_failure
object
Thresholds for ARP failure heuristic alerts
3 properties
switch_bgp_config_type2
string
BGP session type for this switch BGP configuration. enum: external, internal.
ip_type2
string
IP assignment mode for the out-of-band management interface. enum: dhcp, static.
dhcpd_config_option_type2
string
Data type used to encode this DHCP option value. enum: boolean, hex, int16, int32, ip, string, uint16, uint32.
site_setting_ap_synthetic_test2
object
Synthetic test configuration for APs at the site
1 property
site_wids2
object
Wireless intrusion detection settings for the site
1 property
remote_syslog_severity3
string
Syslog severity to match for this selector. enum: alert, any, critical, emergency, error, info, notice, warning.
network_internet_access_destination_nat_property
object
Direct-internet destination NAT rule target settings
4 properties
gateway_path_strategy2
string
Selection strategy used to evaluate the candidate paths. enum: ecmp, ordered, weighted.
site_setting_config_push_policy2
object
Policy controlling how site configuration pushes are applied
2 properties
network_tenant
object
Tenant address entry for a network
1 property
ble_config_power_mode3
string
Transmit power mode for BLE beacons; use custom to set power. enum: custom, default.
gateway_traffic_shaping3
object
Traffic shaping settings applied to the port
3 properties
vars_annotation
object
Annotation for a single var, helping identify its purpose and enabling auto-complete/enumeration in UI
2 properties
day_of_week1
string
Scheduled weekday for automatic signature updates. enum: any, fri, mon, sat, sun, thu, tue, wed.
tunnel_config
object
Gateway tunnel configuration for provider-managed or custom tunnels
18 properties
radius_auth_server
object
RADIUS authentication server settings
8 properties 2 required
gateway_port_config_ip_config2
object
Layer 3 IP configuration for the port
14 properties
evpn_options_overlay2
object
EVPN overlay BGP settings for the topology
1 property
gateway_oob_ip_config3
object
Out-of-band management IP defaults in this gateway template
8 properties
gateway_port_vpn_path_bfd_profile2
string
BFD profile used for this VPN path when the VPN type==hubspoke. enum: broadband, lte.
service_policy_skyatp_iot_device_policy2
object
Device threat policy settings provided by Sky ATP for IoT clients
1 property
gateway_port_lte_auth2
string
If wantype==lte. Authentication method used by the LTE uplink. enum: chap, none, pap.
gateway_port_vpn_path_role2
string
Gateway role for this VPN path; valid values depend on the VPN type. enum: hub, mesh, spoke.
radius_acct_server
object
RADIUS accounting server settings
7 properties 2 required
app_probing1
object
Application probing configuration for gateway monitoring
3 properties
evpn_options_underlay2
object
EVPN underlay BGP and subnet settings for the topology
4 properties
mxcluster_radsec_src_ip_source2
string
Connection source interface or address used when reaching RADIUS servers. enum: any, oob, oob6, tunnel, tunnel6.
tunnel_config_provider2
string
Tunnel provider used when auto provisioning is disabled. enum: custom-ipsec, custom-gre, jse-ipsec, prisma-ipsec, zscaler-gre, zscaler-ipsec.
mxedge_mgmt_oob_ip_type62
string
IPv6 address assignment mode for out-of-band management. enum: autoconf, dhcp, disabled, static.
remote_syslog_archive1
object
Retention settings for this generated syslog file
2 properties
site_zone_occupancy_alert2
object
Occupancy alert settings for site zones
3 properties
service_policy_skyatp_http_inspection_profile2
string
Sky ATP HTTP inspection profile to apply. enum: standard, strict.
site_setting_derived
object
Site settings with derived OAuth account integration data
134 properties
account_oauth_info_account_service_connection
object
Prisma Access service connection region for a linked OAuth account
1 property
vrf_config5
object
VRF defaults applied by this network template
1 property
tunnel_config_auto_provision_node1
object
Backup auto-provisioned tunnel endpoint settings
2 properties
dhcp_snooping4
object
Layer 2 DHCP snooping settings for the site
5 properties
radio_band_antenna_beam_pattern1
string
Beam pattern used by the 6 GHz radio antenna. enum: narrow, medium, wide.
junos_port_config_duplex2
string
Link duplex mode for this Junos port. enum: auto, full, half.
gateway_mgmt3
object
Management access settings for gateways at the site
16 properties
remote_syslog4
object
Syslog forwarding settings for devices at the site
10 properties
wan_extra_routes
object
Additional IPv4 route for a WAN interface
1 property
switch_port_usage_dynamic_reset_default_when2
string
Only if mode==dynamic. Condition that resets a dynamic port to the default port usage. enum: linkdown, none.
gateway_mgmt_auto_signature_update2
object
Schedule for automatic security signature updates
3 properties
service_policy_skyatp_dns_tunnel_detection_profile2
string
Sky ATP DNS tunneling detection profile to apply. enum: default, standard, strict.
mxedge_das2
object
DAS service settings for the site Mist Edge cluster
2 properties
snmp_usm
object
SNMPv3 User-based Security Model configuration
3 properties
tunnel_config_probe_type2
string
Protocol used by the custom IPsec tunnel health probe. enum: http, icmp.
snmpv3_config_notify_filter_item
object
SNMPv3 notification filter profile
3 properties
ospf_area_type2
string
Area type for this OSPF area. enum: default, nssa, stub.
remote_syslog2
object
Remote syslog defaults provided by this network template
10 properties
network_vpn_access_destination_nat_property
object
VPN access destination NAT rule target settings
3 properties
site_setting_status_portal
object
End-user status portal settings for the site
2 properties
switch_mgmt4
object
Management access settings for switches at the site
16 properties
bgp_config
object
BGP session configuration. BFD is enabled when either bfdminimuminterval or bfdmultiplier is configured
22 properties 1 required
protect_re3
object
Control-plane protection settings for the switch
5 properties
tunterm_monitoring_item
object
Monitoring check for tunnel termination reachability
5 properties
site_auto_upgrade_version2
string
Firmware release channel or custom version used for AP auto-upgrade. enum: beta, custom, stable.
day_of_week5
string
Weekly ESL auto-upgrade day for the maintenance window. enum: any, fri, mon, sat, sun, thu, tue, wed.
protect_re_allowed_service
string
Services allowed through protect-RE filters. enum: icmp, ssh
site_setting_tunterm_multicast_config_ssdp2
object
Simple Service Discovery Protocol forwarding settings for tunneled VLANs
2 properties
service_policy_secintel_profile2
string
Protection level applied by SecIntel inspection. enum: default, standard, strict.
vrf_extra_route
object
Additional IPv4 static route for a VRF instance
1 property
evpn_options_vs_instance
object
EVPN virtual-switch instance network mapping
1 property
snmp_config_engine_id_type2
string
Method used to derive the SNMP engine ID. enum: local, usemacaddress.
service_policy_antivirus1
object
Malware and virus inspection settings applied by this service policy
3 properties
proxy3
object
Network proxy settings for devices at the site
2 properties
mxedge_das_coa_server
object
CoA or Disconnect-Message client allowed to contact Mist Edge DAS
6 properties
mxcluster_nac2
object
RADIUS settings for Mist NAC on the site Mist Edge cluster
5 properties
ap_port_config_mac_auth_protocol2
string
Protocol used for MAC authentication when enablemacauth is true. enum: eap-md5, eap-peap, pap.
ap_radio_band242
object
2.4 GHz radio settings for this access point
11 properties
site_setting_critical_url_monitoring_monitor
object
Critical URL monitor definition for site health
2 properties
snmp_config_client_list
object
SNMP client allowlist definition
2 properties
tunnel_config_auto_provision_lat_lng2
object
Geographic coordinate override used for tunnel POP selection
2 properties 2 required
snmpv3_config_target_param_security_level2
string
Required security level for this target parameter profile. enum: authentication, none, privacy.
gw_routing_policy
object
Gateway routing policy made of ordered match-action terms
1 property
idp_profile
object
Organization IDP profile with a base profile and targeted overwrite rules
7 properties
switch_radius_config1
object
RADIUS configuration used when alternate RADIUS settings are required
12 properties
ap_port_config_dynamic_vlan2
object
RADIUS-assigned VLAN settings for AP port authentication
4 properties
gateway_port_usage2
string
Logical usage assigned to the port. enum: hacontrol, hadata, lan, wan.
site_wids_repeated_auth_failures
object
Detection settings for repeated authentication failures
2 properties
synthetictest_config_lan_network
object
configure minis probes to be tested on lan networks of gateways
2 properties
radio_band_antenna_beam_pattern3
string
Beam pattern used by the 5 GHz radio antenna. enum: narrow, medium, wide.
snmp_usm_engine_type2
string
SNMP engine type used for this USM configuration. enum: localengine, remoteengine.
ospf_area_network_auth_type2
string
Authentication method used by this OSPF network. enum: md5, none, password.
config_switch_local_accounts_user
object
Local switch user account credentials and access role
2 properties
vrf_config6
object
Routing instance configuration for the site
1 property
tunnel_config_ipsec_proposal
object
IPsec proposal settings for custom IPsec tunnels
3 properties
site_mxtunnel_protocol2
string
Encapsulation protocol used for this additional Mist Tunnel. enum: ip, udp.
extra_route6_next_qualified_properties
object
Qualified next-hop attributes for an IPv6 static route
2 properties
tacacs_default_role2
string
Default switch-management role to use for TACACS+ logins. enum: admin, helpdesk, none, read.
day_of_week7
string
Scheduled weekday for auto preemption. enum: any, fri, mon, sat, sun, thu, tue, wed.
site_mxtunnel_radsec2
object
TLS-secured RADIUS proxy settings for the site Mist Tunnel
4 properties
mxtunnel_protocol2
string
Encapsulation protocol used for the site Mist Tunnel. enum: ip, udp.
network_internet_access_static_nat_property
object
Direct-internet static NAT rule target settings
3 properties
dhcpd_config_type62
string
IPv6 DHCP mode for this network. enum: local, none, relay.
gateway_template_type2
string
Gateway template deployment type. enum: spoke, standalone.
idp_profile_action2
string
Enforcement action applied when this overwrite rule matches. enum: alert, close, drop.
simple_alert_dhcp_failure
object
Thresholds for DHCP failure heuristic alerts
3 properties
switch_radius_config_auth_server_selection2
string
Selection strategy for RADIUS authentication servers. enum: ordered, unordered.
synthetictest_config_wan_speedtest2
object
WAN speedtest settings for synthetic tests
2 properties
snmp_vacm_access_item
object
VACM access rule for an SNMP group
2 properties
site_wifi2
object
Wireless LAN configuration settings for the site
14 properties
radsec3
object
TLS-secured RADIUS settings for this AP port
9 properties
service_policy_skyatp_dns_dga_detection2
object
Detection settings for DNS DGA threats provided by Sky ATP
2 properties
idp_profile_matching_severity_value
string
enum: critical, info, major, minor
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
junos_port_config_speed1
string
Link speed for this Junos port. enum: 10m, 100m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g, auto.
mxcluster_radsec_acct_server
object
RadSec accounting server settings for a Mist Edge cluster
4 properties
simple_alert_dns_failure
object
Thresholds for DNS failure heuristic alerts
3 properties
gateway_wan_probe_override_probe_profile2
string
WAN probe profile used for health checks on this port. enum: broadband, lte.
response_http404
object
Standard HTTP 404 not found error response
1 property
tacacs_auth_server
object
TACACS+ authentication server settings
4 properties
snmp_vacm_access_item_prefix_list_item_model2
string
Required security model for this VACM access rule. enum: any, usm, v1, v2c.
ap_uwb_config_type
string
UWB integration type. enum: zigpos
site_setting_srx_app
object
Juniper SRX application visibility settings for the site
1 property
gateway_path_preferences_path
object
Candidate path within a gateway path preference
9 properties 1 required
site_rogue1
object
AP threat detection settings for the site
9 properties
bgp_config_neighbors
object
Per-neighbor BGP session settings
7 properties 1 required
tunnel_config_auth_algo3
string
Integrity algorithm used by this IKE proposal. enum: md5, sha1, sha2.
snmpv3_config_target_param
object
SNMPv3 target parameter profile
6 properties
network_internal_access2
object
Internal access settings for this network
1 property
extra_route6
object
IPv6 static route settings for a destination prefix
6 properties
site_setting_switch2
object
Site-level switch feature configuration
32 properties
radius_keywrap_format1
string
Encoding format for RADIUS keywrap KEK and MACK values. enum: ascii, hex.
ap_radio_band53
object
5 GHz radio settings for this access point
12 properties
mxcluster_radsec2
object
TLS-secured RADIUS proxy settings for the site Mist Edge cluster
8 properties
mxcluster_radsec_nas_ip_source2
string
Source used to populate NAS-IP-Address and NAS-IPv6-Address attributes. enum: any, oob, oob6, tunnel, tunnel6.
dot11_bandwidth242
integer
Channel width configured for the 2.4 GHz radio. enum: 0, 20, 40.
ap_uwb_config3
object
UWB RTLS (OMLOX asset visibility) settings for the site, only effective on AP models with a UWB radio and in countries where the UWB radio is permitted. Overri…
5 properties
acl_tag
object
Resource tags (type==resource or type==gbpresource) can only be used in dsttags
9 properties 1 required
synthetictest_config_aggressiveness3
string
Overall aggressiveness level for synthetic test probes. enum: auto, high, med, low.
ip_type62
string
IPv6 address assignment mode for this gateway network interface. enum: autoconf, dhcp, disabled, static.
vrrp_group_auth_type2
string
Authentication method used by the VRRP group. enum: md5, simple.
snmp_vacm_access_item_type2
string
VACM context matching type for this access rule. enum: contextprefix, defaultcontextprefix.
ap_uplink_port_config3
object
AP uplink port configuration for the site
2 properties
iotproxy1
object
Proxy settings for IoT traffic at the site
2 properties
gw_routing_policy_term_action2
object
Policy actions applied when this routing policy term matches
11 properties
vrf_config4
object
VRF defaults applied by this gateway template
1 property
gateway_port_wan_arp_policer2
string
Only when wantype==broadband. ARP policer profile applied to the WAN port. enum: default, max, recommended.
site_setting_juniper_srx_gateway
object
Juniper SRX gateway API connection settings
3 properties
juniper_srx_auto_upgrade2
object
SRX auto-upgrade settings applied when SRX devices are onboarded
4 properties
antenna_select1
string
Internal or external antenna selection for AP models with selectable antennas. enum: , external, internal.
site_setting_tunterm_multicast_config2
object
Multicast settings for tunnel termination at the site
3 properties
switch_mgmt2
object
Management-plane settings applied when this matching rule matches
16 properties
snmp_vacm2
object
SNMPv3 VACM access control configuration
2 properties
gateway_port_config_wan_speedtest_mode2
string
Controls whether Marvis or the scheduler can run speed tests on this WAN port. enum: auto, enabled, disabled.
tunnel_config_ike_proposal
object
IKE proposal settings for custom IPsec tunnels
3 properties
switch_port_usage_mac_auth_protocol2
string
Only if mode!=dynamic and enablemacauth==true. MAC authentication protocol to use; ignored if Mist NAC is enabled. enum: eap-md5, eap-peap, pap.
gw_routing_policy_term
object
Gateway routing policy term with match criteria and actions
2 properties
ap_radio3
object
AP radio configuration for the site
15 properties
snmp_vacm_security_to_group2
object
VACM security-name to group mappings
2 properties
response_http429
object
Standard HTTP 429 rate limit error response
1 property
app_probing_custom_app_protocol2
string
Probe protocol used by this custom application definition. enum: http, icmp.
protect_re_custom_protocol2
string
Transport protocol matched by this custom Protect RE ACL. enum: any, icmp, tcp, udp.
dhcpd_config_option
object
Custom DHCP option value
2 properties
sw_routing_policy_term
object
Switch routing policy term with match criteria and actions
3 properties 1 required
gateway_traffic_shaping1
object
Traffic shaping settings applied to this VPN path
3 properties
acl_tag_type2
string
Classifier type that determines which ACL tag fields are evaluated. enum: any, arubauserrole, dynamicgbp, gbpresource, mac, network, portusage, radiusgroup, re…
site_mxtunnel_additional_mxtunnel
object
Additional named Mist Tunnel configuration for a site
5 properties
tunnel_provider_options_zscaler_sub_location
object
Zscaler sub-location settings for a specific network
14 properties
site_setting_ap_matching_rule
object
AP matching rule for selecting APs and applying port configuration
3 properties
gateway_port_duplex2
string
Ethernet duplex mode configured on the port. enum: auto, full, half.
switch_matching3
object
Matching rules that select switches for this network template
2 properties
idp_profile_matching2
object
Criteria that select signatures for this overwrite rule
3 properties
site_setting_auto_upgrade2
object
Automatic AP firmware upgrade settings for the site. Overrides org setting when provided.
5 properties
dhcp_snooping3
object
DHCP snooping defaults provided by this network template
5 properties
tunnel_config_auto_provision_provider2
string
Tunnel provider used for automatic endpoint provisioning. enum: jse-ipsec, zscaler-ipsec.
synthetictest_config_custom_probe
object
Custom probe definition for synthetic tests
4 properties
ospf_area
object
Property key is the OSPF Area (Area should be a number (0-255) / IP address)
3 properties
switch_network_multicast_igmp_version
string
IGMP version. '2' (default, ASM/IGMPv2) / '3' (SSM/IGMPv3)
snmp_config3
object
Management polling settings for SNMP on site devices
13 properties
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
site_setting_ap_port_config2
object
Ethernet port configuration overrides for APs at the site
1 property
site_setting_tunterm_multicast_config_mdns2
object
Multicast DNS forwarding settings for tunneled VLANs
2 properties
site_engagement_dwell_tags2
object
Visit duration ranges used to assign engagement categories
4 properties
remote_syslog_user
object
User-specific syslog logging rule
3 properties
mxcluster_nac_client_vendor2
string
RADIUS client vendor profile for this IP or subnet. enum: aruba, cisco-aironet, cisco-dnac, cisco-ios, cisco-meraki, brocade, generic, juniper, paloalto.
acl_tag_spec
object
Layer 4 protocol and destination-port match constraint for an ACL tag
2 properties
gateway_path_type2
string
Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
service_policy
object
Site-level service policy that allows or denies traffic for tenants and services
15 properties
ospf_area_network_interface_type2
string
OSPF interface type used for this network. enum: broadcast, nbma, p2mp, p2p.
site_engagement_dwell_tag_names2
object
Display labels for dwell-time visit categories
4 properties
switch_port_usage_mode2
string
Switching mode for this port usage. enum: access, dynamic, inet, trunk.
synthetictest_config_vlan
object
Deprecated VLAN-based synthetic test settings
4 properties
sw_routing_policy_term_action2
object
Policy actions applied when this routing policy term matches
4 properties
switch_port_usage_dynamic_rule
object
Dynamic port usage rule evaluated against LLDP, RADIUS, or peer MAC attributes
6 properties 1 required
ble_config_beacon_rate_mode2
string
Beacon rate mode for Mist BLE beacons; use custom to set beaconrate. enum: custom, default.
ip_type11
string
IP assignment mode for in-band switch management. enum: dhcp, static.
service_policy_skyatp2
object
Threat inspection settings provided by Sky ATP for this service policy
4 properties
response_http401
object
Standard HTTP 401 authentication error response
1 property
tunnel_config_node_probe_http2
object
HTTP probe settings for this tunnel node; success from any ICMP or HTTP probe indicates the tunnel is up
2 properties
site_setting_paloalto_networks2
object
Firewall integration settings for Palo Alto Networks at the site
2 properties
snmp_config_v2c_config
object
SNMPv2c community configuration entry
4 properties
service_policy_appqoe1
object
Application QoE settings applied by this service policy
1 property
mxedge_mgmt4
object
Mist Edge management access settings for the site
6 properties
switch_radius2
object
Management authentication settings using RADIUS
3 properties
remote_syslog_server_protocol2
string
Transport protocol used for this remote syslog server. enum: tcp, udp.
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
mxcluster_radsec_auth_server
object
RadSec authentication server settings for a Mist Edge cluster
12 properties
ap_port_config
object
Ethernet port behavior settings for an access point
17 properties
switch_bgp_config
object
Switch BGP configuration for a routing instance
9 properties 2 required
switch_port_mirroring_property
object
Input and output settings for one switch port mirroring session
6 properties
switch_multicast_config1
object
Multicast settings for networks in the master VRF (not assigned to any vrfinstances); PIM is automatically enabled when any master-VRF network has multicast.en…
4 properties
snmpv3_config_target_address_item
object
SNMPv3 notification target address entry
6 properties
marvis1
object
AI assistant settings for Marvis at the site
1 property
service_policy_ssl_proxy3
object
TLS inspection settings applied by this service policy
2 properties
tunnel_config_ike_dh_group2
string
Diffie-Hellman group used by this IKE proposal. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5.
tunnel_config_tunnel_mode2
string
Tunnel failover mode used for primary and secondary endpoints. enum: active-active, active-standby.
ip_type12
string
IP assignment mode for out-of-band switch management. enum: dhcp, static.
ap_port_config_forwarding2
string
Traffic forwarding mode for this AP Ethernet port. enum: all, limited, mxtunnel, sitemxedge, wxtunnel.
switch_mgmt3
object
Management-plane defaults provided by this network template
16 properties
site_setting_wan_vna2
object
Virtual Network Assistant settings for WAN experiences at the site
1 property
switch_port_usage_dynamic_rule_src2
string
Source attribute evaluated by this dynamic rule. enum: linkpeermac, lldpchassisid, lldphardwarerevision, lldpmanufacturername, lldpoui, lldpserialnumber, lldps…
network_source_nat2
object
Source NAT settings used when non-routed spoke hosts must be reachable from the hub
1 property
remote_syslog_console2
object
Log forwarding filters for console messages sent to remote syslog
1 property
tunnel_config_dh_group2
string
Diffie-Hellman group used by this IPsec proposal. enum: 1, 14, 15, 16, 19, 2, 20, 21, 24, 5.
gateway_extra_route
object
Gateway IPv4 extra route next-hop settings
1 property
service_policy_ewf_rule
object
Enhanced web filtering rule applied by a service policy
4 properties
service_policy_skyatp_http_inspection2
object
Web traffic inspection settings provided by Sky ATP
2 properties
site_setting_wired_vna2
object
Virtual Network Assistant settings for wired experiences at the site
1 property
site_wifi_proxy_arp2
string
ARP proxy mode for site Wi-Fi. enum: default, disabled, enabled.
gateway_extra_route6
object
Gateway IPv6 extra route next-hop settings
1 property
sw_routing_policy_term_matching_protocol_enum
string
enum: bgp, direct, evpn, ospf, static
snmpv3_config_notify_items
object
SNMPv3 notification definition for traps or informs
3 properties
network_internet_access2
object
Direct internet access and NAT settings for this network
5 properties
tunnel_config_probe
object
Tunnel health probe settings
4 properties
sw_routing_policy
object
Switch routing policy made of ordered match-action terms
1 property
remote_syslog_file_config
object
Generated syslog file output settings
7 properties
remote_syslog_facility1
string
Default syslog facility for messages sent to this server. enum: any, authorization, change-log, config, conflict-log, daemon, dfc, external, firewall, ftp, int…
synthetictest_config_aggressiveness1
string
Probe aggressiveness level for this custom synthetic probe. enum: auto, high, med, low.
radius_config2
object
RADIUS authentication and accounting settings for this AP port
9 properties
snmp_config_trap_version2
string
SNMP trap protocol version used by this group. enum: all, v1, v2.
radio_band_antenna_mode2
string
Radio chain mode for the 6 GHz radio. enum: 1x1, 2x2, 3x3, 4x4, default.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

juniper-sites-setting-api-openapi.yml Raw ↑

Other APIs Juniper Networks publishes across the network.

Junos PyEZ (Python API)
JSNAPy API
Juniper Networks Allowlists and Blocklists API
Juniper Networks Analytics API
Juniper Networks Audit Logs API
Juniper Networks Authentication API
Juniper Networks BGP Routers API
Juniper Networks Blueprints API
Juniper Networks Clients API
Juniper Networks Configlets API
Juniper Networks Configuration API
Juniper Networks Connectivity Templates API
Where this information came from

This is an independent, third-party profile of Juniper Networks 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.