Juniper Networks Sites Devices API
Mist provides many ways (device_type specific template, site template, device profile, per-device) to configure devices for different kind of scenarios.The precedence goes from most specific to least specificDevice > Device Profile > RFTemplate (for AP only) > DeviceType-specific Template > Site Template > Site Setting
Juniper Networks Sites Devices 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 Devices. 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 16 operations across 14 paths, and defines 389 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.
16 operations
14 paths
389 schemas
1 DELETE11 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Juniper Networks Sites Devices 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 16
Across 14 paths, the API surfaces 16 operations — 1 DELETE, 11 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Sites Devices 16
Mist provides many ways (devicetype specific template, site template, device profile, per-device) to configure devices for different kind of scenarios. The precedence goes from mo…
GET
/api/v1/sites/{site_id}/devices
listSiteDevices
GET
/api/v1/sites/{site_id}/devices/config_history/count
countSiteDeviceConfigHistory
GET
/api/v1/sites/{site_id}/devices/config_history/search
searchSiteDeviceConfigHistory
GET
/api/v1/sites/{site_id}/devices/count
countSiteDevices
GET
/api/v1/sites/{site_id}/devices/events/count
countSiteDeviceEvents
GET
/api/v1/sites/{site_id}/devices/events/search
searchSiteDeviceEvents
GET
/api/v1/sites/{site_id}/devices/export
exportSiteDevices
POST
/api/v1/sites/{site_id}/devices/gbp_tag
setSiteDevicesGbpTag
POST
/api/v1/sites/{site_id}/devices/import
importSiteDevices
GET
/api/v1/sites/{site_id}/devices/last_config/count
countSiteDeviceLastConfig
GET
/api/v1/sites/{site_id}/devices/last_config/search
searchSiteDeviceLastConfigs
GET
/api/v1/sites/{site_id}/devices/search
searchSiteDevices
GET
/api/v1/sites/{site_id}/devices/{device_id}
getSiteDevice
PUT
/api/v1/sites/{site_id}/devices/{device_id}
updateSiteDevice
DELETE
/api/v1/sites/{site_id}/devices/{device_id}/image/{image_number}
deleteSiteDeviceImage
POST
/api/v1/sites/{site_id}/devices/{device_id}/image/{image_number}
addSiteDeviceImage
Schemas 389
The contract defines 389 schemas that model the data the API accepts and returns. The most detailed are device_switch (63 properties), device_ap (50 properties), gateway_port_config (48 properties), device_gateway (47 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
ap_led5
object
Indicator light behavior settings for this access point
2 properties
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.
ip_type13
string
IPv4 address assignment mode for AP management traffic. enum: dhcp, static.
ap_iot_output6
object
Analog-capable IoT pin A1 output settings
5 properties
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
switch_port_usage_duplex2
string
Only if mode!=dynamic. Link duplex mode for this port usage. enum: auto, full, half.
ap_aeroscout1
object
Location integration settings for AeroScout on this access point
4 properties
switch_port_local_usage_mode2
string
Switching mode for this local port configuration. enum: access, inet, trunk.
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.
switch_virtual_chassis2
object
Virtual Chassis membership and provisioning settings for this switch
2 properties
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.
network_vpn_access_config
object
VPN access settings for a network and VPN pair
14 properties
gateway_search
object
Gateway record returned by device search endpoints
27 properties
1 required
snmp_usm_user
object
SNMPv3 USM user definition
5 properties
remote_syslog_archive3
object
Retention settings for generated syslog archive files
2 properties
ap_esl_type2
string
ESL integration type to enable on the AP. enum: hanshow, imagotag, native, solum.
remote_syslog_time_format2
string
Timestamp format used in forwarded syslog messages. enum: millisecond, year, year millisecond.
ap_uwb_config4
object
UWB RTLS / OMLOX asset-visibility settings; overrides the device profile and site-level uwbconfig
5 properties
ap_radio_band62
object
6 GHz radio settings for this access point
13 properties
ap_iot_pullup3
string
Selects the pull-up resistor mode applied to the output pin. enum: external, internal, none.
ap_zigbee3
object
Zigbee radio and network settings for this access point
5 properties
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.
switch_ospf_config_area
object
Settings for a single OSPF area on a switch
1 property
junos_port_config
object
Junos switch port configuration
19 properties
1 required
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.
config_switch_local_accounts_user_role2
string
Access role granted to the local switch user account. enum: admin, helpdesk, none, read.
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
switch_mgmt6
object
Management-plane settings for this switch
16 properties
response_events_devices
object
Paginated response for site device event search results
6 properties
5 required
tunnel_config_node3
object
Main remote tunnel endpoint settings
9 properties
2 required
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
response_http400
object
Standard HTTP 400 bad request error response
1 property
switch_iot_port
object
Switch IOT port configuration
4 properties
wlan_mist_nac3
object
Juniper Mist NAC settings used by AP port authentication
9 properties
ap_mqtt_broker_proto2
string
MQTT broker transport protocol. enum: ssl, tcp.
dhcpd_config_fixed_binding
object
Static DHCP binding for a client MAC address
3 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
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
snmpv3_config_notify_filter_item_content
object
OID filter rule for an SNMPv3 notification profile
2 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
tunnel_provider_options4
object
Provider-specific options for tunnels terminated by this gateway
3 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.
site_device_last_config_count_distinct
string
enum: mac, name, siteid, version
vrf_config1
object
VRF configuration applied to this gateway
1 property
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
dhcpd_config_property
object
DHCP server or relay configuration for one network
16 properties
dot11_band
string
enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
ap_radio_antenna_mode2
string
Selected radio chain mode for AP models that support antenna mode control. enum: 1x1, 2x2, 3x3, 4x4, default.
ap_iot_output2
object
Analog-capable IoT pin A3 output settings
5 properties
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.
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
gateway_port_mirroring2
object
Port mirroring configuration for this gateway
1 property
devices_gbp_tag
object
Request body for assigning a GBP tag to multiple devices
2 properties
2 required
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
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
switch_dhcpd_config_property
object
DHCP server or relay configuration for one switch network. The property key is the network name. In case of DHCP relay, it's common for many networks to use th…
16 properties
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
service_policy_ewf_rule_profile2
string
Enhanced web filtering profile applied by this rule. enum: critical, standard, strict.
network_vpn_access_static_nat_property
object
VPN access static NAT rule target settings
2 properties
switch_dhcpd_config_type62
string
IPv6 DHCP mode for this switch network. enum: none, relay, server.
gateway_vrf_instance
object
Gateway VRF instance and its member networks
1 property
ap_iot3
object
Digital and analog IoT pin settings for this access point
7 properties
radio_band_antenna_mode1
string
Radio chain mode for the 5 GHz radio. enum: 1x1, 2x2, 3x3, 4x4, default.
junos_port_config_speed3
string
Link speed for this local port configuration. enum: 10m, 100m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g, auto.
ip_type5
string
IP assignment mode for the node1 out-of-band management interface. enum: dhcp, static.
gw_routing_policy_term_matching2
object
Route match criteria that must be satisfied before actions are applied
9 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
switch_port_config_overwrite
object
Switch port configuration overrides
8 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
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
count_result
object
Count result row with the matching distinct field values
1 property
1 required
tunnel_config_auto_provision2
object
Provider auto-provisioning settings for tunnel endpoints
7 properties
1 required
mist_device
Mist-managed device object for an AP, switch, or gateway
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
switch_port_local_usage_mac_auth_protocol2
string
Only if enablemacauth==true, MAC authentication protocol to use. enum: eap-md5, eap-peap, pap.
switch_bgp_config_hold_time_zero
integer
BGP hold time value of 0
ip_type1
string
IP assignment mode for this Junos IP configuration. enum: dhcp, static.
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
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
gateway_port_wan_type2
string
Only if usage==wan. WAN uplink type configured on the port. enum: broadband, dsl, lte.
switch_dhcpd_config_type2
string
IPv4 DHCP mode for this switch network. enum: none, relay, server.
snmp_usm_user_encryption_type2
string
Privacy protocol used by this SNMPv3 USM user. enum: privacy-3des, privacy-aes128, privacy-des, privacy-none.
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
ha_cluster_node_enum
string
HA cluster node selector. enum: node0, node1
tacacs2
object
Management authentication settings using TACACS+
5 properties
ip_type3
string
IPv4 assignment mode for the additional Junos L3 presence. enum: dhcp, static.
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
device_type_default_ap
string
enum: ap, gateway, switch
vrrp_config3
object
VRRP configuration applied to this switch
2 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
switch_port_local_usage_duplex2
string
Link duplex mode for this local port configuration. enum: auto, full, half.
bgp_config_via2
string
Transport used for this BGP session, such as LAN, tunnel, VPN, or WAN
response_config_history_search_item_radio
object
Radio config history detail
2 properties
2 required
protect_re1
object
Control-plane protection settings for the gateway
5 properties
junos_local_port_config
object
Per-port Switch Port Operator (SPO) override configuration used in localportconfig to customize settings inherited from portconfig
37 properties
1 required
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.
switch_oob_ip_config3
object
Out-of-band management IP configuration for this switch
7 properties
switch_mist_nac5
object
Mist NAC settings applied to this switch
2 properties
device_ap_lacp_config3
object
Link aggregation settings for supported AP Ethernet uplinks
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
webhook_device_events_event_ev_type2
string
Advisory severity for the device event. enum: notice, warn.
network_multicast2
object
Settings for multicast routing on this network
3 properties
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.
search_site_devices_mxtunnel_status
string
Mist Tunnel status filter for site device search. enum: down, up
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
evpn_config3
object
EVPN configuration applied to this switch
2 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
switch_bgp_config_type2
string
BGP session type for this switch BGP configuration. enum: external, internal.
site_devices_count_distinct
string
enum: hostname, lldpmgmtaddr, lldpportid, lldpsystemdesc, lldpsystemname, mapid, model, mxedgeid, mxtunnelstatus, version
config_device
Device configuration object for an AP, switch, or gateway
ip_type2
string
IP assignment mode for the out-of-band management interface. enum: dhcp, static.
response_config_history_search_item
object
Device config history entry
11 properties
5 required
dhcpd_config_option_type2
string
Data type used to encode this DHCP option value. enum: boolean, hex, int16, int32, ip, string, uint16, uint32.
ap_iot_input3
object
Digital input pin DI1 settings
3 properties
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.
ap_usb3
object
Legacy USB integration settings for this access point
8 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
site_device_events_count_distinct
string
enum: mac, model, type, typecode
tunnel_config
object
Gateway tunnel configuration for provider-managed or custom tunnels
18 properties
day_of_week1
string
Scheduled weekday for automatic signature updates. enum: any, fri, mon, sat, sun, thu, tue, wed.
radius_auth_server
object
RADIUS authentication server settings
8 properties
2 required
ap_mesh_role2
string
Mesh role for this AP, either base or remote
gateway_port_config_ip_config2
object
Layer 3 IP configuration for the port
14 properties
switch_port_local_usage_dot1x2
string
802.1X authentication mode for this local port configuration. enum: dot1x.
switch_dhcpd_config3
object
DHCP server configuration served by this switch
1 property
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
last_config_device_type
string
enum: ap, gateway, mxedge, switch
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.
remote_syslog_archive1
object
Retention settings for this generated syslog file
2 properties
service_policy_skyatp_http_inspection_profile2
string
Sky ATP HTTP inspection profile to apply. enum: standard, strict.
search_site_devices_sort
string
enum: mac, model, sku, timestamp
ip_type61
string
IPv6 assignment mode for the additional Junos L3 presence. enum: autoconf, dhcp, disabled, static.
ap_iot_output4
object
Digital output pin DO settings
5 properties
ap_radio4
object
Radio configuration overrides for this access point
15 properties
tunnel_config_auto_provision_node1
object
Backup auto-provisioned tunnel endpoint settings
2 properties
switch_search
object
Switch record returned by device search endpoints
24 properties
1 required
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.
device_event
object
Device event payload returned by search and webhook APIs
34 properties
3 required
device_gateway
object
Gateway configuration and placement data
47 properties
1 required
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.
ap_mqtt_format2
string
Payload format for published messages. enum: json, raw.
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.
gateway_port_mirroring_port_mirror2
object
Mirroring rule that copies ingress traffic from source ports to an output port
5 properties
snmpv3_config_notify_filter_item
object
SNMPv3 notification filter profile
3 properties
snmp_config5
object
SNMP configuration for this switch
13 properties
ap_airista1
object
Location integration settings for Airista on this access point
3 properties
ospf_area_type2
string
Area type for this OSPF area. enum: default, nssa, stub.
remote_syslog5
object
Remote syslog settings for this switch
10 properties
ap_search
object
Access point record returned by device search endpoints
36 properties
4 required
network_vpn_access_destination_nat_property
object
VPN access destination NAT rule target settings
3 properties
response_count
object
Distinct count response for time-bounded search results
6 properties
6 required
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
protect_re_allowed_service
string
Services allowed through protect-RE filters. enum: icmp, ssh
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
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
dhcp_snooping5
object
DHCP snooping configuration for this switch
5 properties
ap_port_config_mac_auth_protocol2
string
Protocol used for MAC authentication when enablemacauth is true. enum: eap-md5, eap-peap, pap.
device_switch
object
You can configure portusages and networks settings at the device level, but most of the time it's better use the Site Setting to achieve better consistency and…
63 properties
1 required
device_search_radius_filter_status1
string
RADIUS authentication server status for this server in device search results. enum: up, down, unreachable.
ap_radio_band242
object
2.4 GHz radio settings for this access point
11 properties
snmp_config_client_list
object
SNMP client allowlist definition
2 properties
switch_radius_config6
object
RADIUS authentication and accounting settings for this switch
12 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.
snmp_usm_engine_type2
string
SNMP engine type used for this USM configuration. enum: localengine, remoteengine.
radio_band_antenna_beam_pattern3
string
Beam pattern used by the 5 GHz radio antenna. enum: narrow, medium, wide.
vrf_config8
object
VRF configuration applied to this switch
1 property
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
ap_mqtt3
object
MQTT broker publishing settings for this access point
8 properties
tunnel_config_ipsec_proposal
object
IPsec proposal settings for custom IPsec tunnels
3 properties
extra_route6_next_qualified_properties
object
Qualified next-hop attributes for an IPv6 static route
2 properties
ap_esl_config1
object
Electronic shelf label integration settings for this access point
8 properties
tacacs_default_role2
string
Default switch-management role to use for TACACS+ logins. enum: admin, helpdesk, none, read.
network_internet_access_static_nat_property
object
Direct-internet static NAT rule target settings
3 properties
response_device_search_results_items
Device search record for an AP, switch, or gateway
dhcpd_config_type62
string
IPv6 DHCP mode for this network. enum: local, none, relay.
idp_profile_action2
string
Enforcement action applied when this overwrite rule matches. enum: alert, close, drop.
switch_radius_config_auth_server_selection2
string
Selection strategy for RADIUS authentication servers. enum: ordered, unordered.
search_site_devices_desc_sort
string
enum: mac, model, sku, timestamp
snmp_vacm_access_item
object
VACM access rule for an SNMP group
2 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.
response_http404
object
Standard HTTP 404 not found error response
1 property
ap_client_bridge_auth_type2
string
Authentication mode for the client bridge connection. enum: open, psk.
tacacs_auth_server
object
TACACS+ authentication server settings
4 properties
gateway_wan_probe_override_probe_profile2
string
WAN probe profile used for health checks on this port. enum: broadband, lte.
response_config_history_search_item_wlan
object
WLAN config history detail
5 properties
3 required
snmp_vacm_access_item_prefix_list_item_model2
string
Required security model for this VACM access rule. enum: any, usm, v1, v2c.
switch_iot_port_input_src2
string
Only for OUT ports. Input port that triggers this output port. enum: IN0, IN1.
ap_uwb_config_type
string
UWB integration type. enum: zigpos
junos_other_ip_config
object
Optional switch L3 presence on an additional network or VLAN
7 properties
gateway_path_preferences_path
object
Candidate path within a gateway path preference
9 properties
1 required
vrrp_config_group
object
VRRP group behavior settings
2 properties
bgp_config_neighbors
object
Per-neighbor BGP session settings
7 properties
1 required
ap_pwr_config3
object
Power negotiation and peripheral power settings for this access point
2 properties
dhcpd_config4
object
DHCP server configuration served by this gateway
1 property
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
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
dot11_bandwidth242
integer
Channel width configured for the 2.4 GHz radio. enum: 0, 20, 40.
acl_tag
object
Resource tags (type==resource or type==gbpresource) can only be used in dsttags
9 properties
1 required
ap_usb_type2
string
USB integration type for this legacy AP USB configuration. enum: hanshow, imagotag, solum.
ip_type62
string
IPv6 address assignment mode for this gateway network interface. enum: autoconf, dhcp, disabled, static.
snmp_vacm_access_item_type2
string
VACM context matching type for this access rule. enum: contextprefix, defaultcontextprefix.
gw_routing_policy_term_action2
object
Policy actions applied when this routing policy term matches
11 properties
gateway_port_wan_arp_policer2
string
Only when wantype==broadband. ARP policer profile applied to the WAN port. enum: default, max, recommended.
antenna_select1
string
Internal or external antenna selection for AP models with selectable antennas. enum: , external, internal.
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.
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.
tunnel_config_ike_proposal
object
IKE proposal settings for custom IPsec tunnels
3 properties
ap_zigbee_allow_join2
string
Join policy for new Zigbee devices on this AP. enum: always, manual.
gw_routing_policy_term
object
Gateway routing policy term with match criteria and actions
2 properties
snmp_vacm_security_to_group2
object
VACM security-name to group mappings
2 properties
ap_iot_pullup1
string
Selects the pull-up resistor mode applied to the input pin. enum: external, internal, none.
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
device_ap
object
Access point configuration and placement data
50 properties
1 required
acl_tag_type2
string
Classifier type that determines which ACL tag fields are evaluated. enum: any, arubauserrole, dynamicgbp, gbpresource, mac, network, portusage, radiusgroup, re…
tunnel_provider_options_zscaler_sub_location
object
Zscaler sub-location settings for a specific network
14 properties
switch_stp_config4
object
Spanning Tree Protocol configuration for this switch
1 property
gateway_port_duplex2
string
Ethernet duplex mode configured on the port. enum: auto, full, half.
switch_port_usage_speed_overwrite2
string
Link speed override for the switch port. enum: 10m, 100m, 1g, 2.5g, 5g, 10g, 25g, 40g, 100g, auto.
ap_search_wlan
object
WLAN summary included in an AP search result
2 properties
device_search_radius_stat
object
RADIUS authentication counters and server status for a device search result
4 properties
idp_profile_matching2
object
Criteria that select signatures for this overwrite rule
3 properties
ap_iot_input1
object
Digital input pin DI2 settings
3 properties
tunnel_config_auto_provision_provider2
string
Tunnel provider used for automatic endpoint provisioning. enum: jse-ipsec, zscaler-ipsec.
switch_virtual_chassis_member
object
Virtual Chassis member identified by MAC address and role
3 properties
3 required
response_device_search
object
Paginated response for organization or site device search results
6 properties
5 required
ospf_area
object
Property key is the OSPF Area (Area should be a number (0-255) / IP address)
3 properties
device_type6
string
Device type associated with the event. enum: ap, gateway, switch.
switch_network_multicast_igmp_version
string
IGMP version. '2' (default, ASM/IGMPv2) / '3' (SSM/IGMPv3)
ap_client_bridge_auth2
object
Credentials and security mode used when the AP connects as a wireless client bridge
2 properties
switch_port_local_usage_storm_control
object
Storm-control settings for this local port configuration
6 properties
response_config_history_search
object
Paginated device config history search response
6 properties
5 required
gateway_mgmt4
object
Management-plane settings for this gateway
16 properties
remote_syslog_user
object
User-specific syslog logging rule
3 properties
ap_centrak1
object
Location integration settings for Centrak on this access point
1 property
acl_tag_spec
object
Layer 4 protocol and destination-port match constraint for an ACL tag
2 properties
service_policy
object
Site-level service policy that allows or denies traffic for tenants and services
15 properties
gateway_path_type2
string
Gateway path source type, such as local network, WAN interface, VPN path, or tunnel
ap_iot_output3
object
Analog-capable IoT pin A4 output settings
5 properties
ospf_area_network_interface_type2
string
OSPF interface type used for this network. enum: broadcast, nbma, p2mp, p2p.
ap_client_bridge1
object
Wireless client bridge settings for this access point
3 properties
switch_port_usage_mode2
string
Switching mode for this port usage. enum: access, dynamic, inet, trunk.
switch_ospf_config2
object
OSPF routing configuration for this switch
5 properties
sw_routing_policy_term_action2
object
Policy actions applied when this routing policy term matches
4 properties
evpn_config_role2
string
EVPN topology role for the switch. enum: access, border, collapsed-core, core, distribution, esilag-access, none.
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.
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
ap_iot_output1
object
Analog-capable IoT pin A2 output settings
5 properties
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
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
switch_radius2
object
Management authentication settings using RADIUS
3 properties
gateway_oob_ip_config4
object
Out-of-band management IP configuration for this gateway
8 properties
remote_syslog_server_protocol2
string
Transport protocol used for this remote syslog server. enum: tcp, udp.
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_iot_port_alarm_class2
string
Alarm severity class raised for input-triggered switch IOT port events. enum: minor, major.
ap_ip_config4
object
Management IP addressing settings for this access point
12 properties
snmpv3_config_target_address_item
object
SNMPv3 notification target address entry
6 properties
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.
ap_uplink_port_config4
object
Authentication and failover behavior for AP uplink ports
2 properties
tunnel_config_tunnel_mode2
string
Tunnel failover mode used for primary and secondary endpoints. enum: active-active, active-standby.
ap_port_config_forwarding2
string
Traffic forwarding mode for this AP Ethernet port. enum: all, limited, mxtunnel, sitemxedge, wxtunnel.
switch_port_usage_duplex_overwrite2
string
Link duplex mode override for the switch port. enum: auto, full, half.
junos_ip_config3
object
Management IP addressing settings for this switch
7 properties
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
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
ap_mesh3
object
Wireless mesh role and band settings for this access point
5 properties
snmpv3_config_notify_items
object
SNMPv3 notification definition for traps or informs
3 properties
ble_config4
object
Bluetooth Low Energy beacon and asset settings for this access point
27 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
switch_virtual_chassis_member_vc_role2
string
Role of this member in the Virtual Chassis. enum: backup, linecard, master.
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…
ip_type64
string
IPv6 address assignment mode for AP management traffic. enum: autoconf, dhcp, disabled, static.
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
More from Juniper Networks 12
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
#Sites Devices
Where this information came from
This is an independent, third-party profile of Juniper Networks Sites Devices 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.