Juniper Mist AI Orgs Setting API
API Calls to manage the Mist Organization Settings
Juniper Mist AI Orgs Setting API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orgs Setting. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 4 paths, and defines 122 schemas. It is described by OpenAPI 3.1.0, at version 2604.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.
6 operations
4 paths
122 schemas
1 DELETE1 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Juniper Mist AI Orgs Setting API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…basicAuth— While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.csrfToken— This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Orgs Setting 6
API Calls to manage the Mist Organization Settings
GET
/api/v1/orgs/{org_id}/setting
getOrgSettings
PUT
/api/v1/orgs/{org_id}/setting
updateOrgSettings
DELETE
/api/v1/orgs/{org_id}/setting/blacklist
deleteOrgWirelessClientsBlocklist
POST
/api/v1/orgs/{org_id}/setting/blacklist
createOrgWirelessClientsBlocklist
POST
/api/v1/orgs/{org_id}/setting/pcap_bucket/setup
setOrgCustomBucket
POST
/api/v1/orgs/{org_id}/setting/pcap_bucket/verify
verifyOrgCustomBucket
Schemas 122
The contract defines 122 schemas that model the data the API accepts and returns. The most detailed are org_setting (52 properties), org_setting_mist_nac (15 properties), org_setting_auto_assignment_rule (12 properties), mxedge_mgmt (6 properties). Each schema is shown below with its type and property counts.
synthetictest_config_custom_probe
object
4 properties
switch_auto_upgrade_custom_versions
object
Custom version to be used. The Property Key is the switch hardware and the property value is the firmware version
org_setting_junos_shell_access_read
string
enum: admin, viewer, none
simple_alert_dhcp_failure
object
3 properties
time_of_day
string
any / HH:MM (24-hour format)
strings
array
account_juniper_info
object
1 property
org_setting_gateway_mgmt_host_in_policy
object
1 property
app_probing_apps
array
APp-keys from [List Applications](/operations/listApplications)
marvis_self_driving
object
Self-driving network automation settings per domain
3 properties
juniper_srx_auto_upgrade_custom_versions
object
Property key is the SRX Hardware model (e.g. "SRX4600")
idp_machine_cert_lookup_field
string
allow customer to choose the EAP-TLS client certificate's field to use for IDP Machine Groups lookup. enum: automatic, cn, dns
synthetictest_config_aggressiveness
string
enum: auto, high, low
synthetictest_config_vlan_vlan_ids
array
org_setting_auto_deviceprofile_assignment
object
2 properties
optic_port_config
object
Property key is the interface name or range (e.g. et-0/0/47, et-0/0/48-49)
org_setting_jcloud
object
3 properties
ssr_proxy
object
SSR proxy configuration to talk to Mist
2 properties
org_setting_cloudshark
object
2 properties
org_setting_mist_nac_fingerprinting_wireless_coa
string
enum: reauth, disconnect
radsec_certs_ap
array
RADSec certificates for AP
org_setting_junos_shell_access_helpdesk
string
enum: admin, viewer, none
pcap_bucket_verify
object
2 properties
2 required
cacerts
array
List of PEM-encoded ca certs
org_setting_gateway_mgmt_overlay_ip
object
2 properties
org_setting_gateway_mgmt_app_probing
object
1 property
org_setting_wireless_pma
object
1 property
gateway_mgmt_host_out_policy
object
1 property
org_setting_celona
object
2 properties
org_setting_installer_extra_site_ids
array
response_http401
object
1 property
org_setting_auto_assignment_rule
object
Autorules in org settings
12 properties
1 required
org_setting_auto_device_naming
object
2 properties
org_setting_switch_mgmt
object
1 property
org_setting_pcap
object
2 properties
org_setting_junos_shell_access_write
string
enum: admin, viewer, none
simple_alert
object
Set of heuristic rules will be enabled when marvis subscription is not available. It triggers when, in a Z minute window, there are more than Y distinct client…
3 properties
synthetictest_config_lan_networks_networks
array
List of networks to be used for synthetic tests
org_setting_gateway_mgmt
object
6 properties
org_setting_mist_nac_fingerprinting
object
Allows customer to enable client fingerprinting for policy enforcement
4 properties
org_setting_tags
array
List of tags
org_setting_junos_shell_access
object
junosshellaccess: Manages role-based web-shell access. When junosshell access is not defined (Default) - No additional users are configured and web-shell uses…
4 properties
pcap_bucket
object
1 property
1 required
org_setting_junos_shell_access_admin
string
enum: admin, viewer, none
org_setting_api_policy
object
1 property
vlan_id_with_variable
org_setting_mist_nac_server_cert
object
radius server cert to be presented in EAP TLS
3 properties
org_setting_auto_device_naming_rules
arraynull
org_setting_mist_nac_idp
object
3 properties
org_setting_mist_nac_mdm
object
MDM (Mobile Device Management) CoA configuration
1 property
org_setting_marvis
object
1 property
gateway_mgmt_host_out_policy_syslog_server
object
Allows to define the hostoutpolicy per Syslog Server. The Property key is the Syslog name
3 properties
msp_id
string
simple_alert_arp_failure
object
3 properties
org_setting_auto_deviceprofile_assignment_rules
arraynull
org_setting_jcloud_ra
object
JCloud Routing Assurance connexion
3 properties
created_time
number
When the object has been created, in epoch
synthetictest_config
object
6 properties
org_setting_mist_nac_ip_version
string
by default, NAS devices(switches/aps) and proxies(mxedge) are configured to reach mist-nac via IPv4. enum: v4, v6
mac_addresses_macs
array
org_setting_cradlepoint
object
5 properties
org_setting_auto_site_assignment_rules
arraynull
org_setting_device_cert
object
common device cert, optional
2 properties
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
response_pcap_bucket_config
object
2 properties
setting_ssr_auto_upgrade_custom_versions
object
Property key is the SSR model (e.g. "SSR130").
synthetictest_config_wan_speedtest
object
2 properties
org_setting_mgmt
object
management-related properties
3 properties
org_setting_mist_nac_idp_user_realms
array
Which realm should trigger this IDP. User Realm is extracted from: Username-AVP (mist.com from john@mist.com) Cert CN
mxedge_mgmt
object
6 properties
mac_addresses
object
1 property
1 required
setting_ssr
object
5 properties
org_setting_mgmt_mxtunnel_ids
array
List of Mist Tunnels
synthetictest_config_custom_probes
object
Custom probes to be used for synthetic tests
org_setting_mist_nac_idps
array
nac_coa_type
string
CoA type to send. enum: reauth, disconnect
org_setting_wired_pma
object
1 property
response_http429
object
1 property
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
org_setting_mist_nac
object
15 properties
ssr_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
org_setting_auto_device_naming_rule_src
string
enum: lldpportdesc, mac
org_setting
object
Org Settings
52 properties
gateway_mgmt_host_out_policy_syslog
object
2 properties
org_id
string
org_setting_switch
object
1 property
synthetictest_config_vlan
object
4 properties
id
string
Unique ID of the object instance in the Mist Organization
simple_alert_dns_failure
object
3 properties
org_setting_auto_site_assignment
object
2 properties
marvis_self_driving_domain
object
1 property
response_http403
object
1 property
synthetictest_config_vlan_custom_test_urls
array
idp_user_cert_lookup_field
string
allow customer to choose the EAP-TLS client certificate's field. To use for IDP User Groups lookup. enum: automatic, cn, email, upn
switch_auto_upgrade
object
3 properties
org_setting_installer
object
4 properties
org_setting_gateway_mgmt_host_in_policies
object
2 properties
optic_port_config_port
object
2 properties
org_setting_auto_site_assignment_src
string
enum: extip, dnssuffix, geoip, lldpportdesc, lldpsystemname, model, name, subnet
org_setting_mist_nac_idp_exclude_realms
array
When the IDP of mxedgeproxy type, exclude the following realms from proxying in addition to other valid home realms in this org
gateway_mgmt_host_out_policy_syslog_servers
array
response_http404
object
1 property
org_setting_password_policy
object
password policy
5 properties
org_setting_auto_device_naming_rule
object
5 properties
response_http400
object
1 property
device_type_default_ap
string
enum: ap, gateway, switch
juniper_account
object
2 properties
synthetictest_config_lan_networks
array
List of networks to be used for synthetic tests
synthetictest_config_lan_network
object
configure minis probes to be tested on lan networks of gateways
2 properties
org_setting_gateway_mgmt_host_out_policies
object
optional, for some of the host-out traffic, the path preference can be specified by default, ECMP will be used from all available route/path available services…
3 properties
org_setting_vpn_options
object
3 properties
org_setting_juniper_srx
object
1 property
setting_ssr_auto_upgrade
object
autoupgrade device first time it is onboarded
4 properties
synthetictest_config_vlans
array
setting_ssr_conductor_hosts
array
List of Conductor IP Addresses or Hosts to be used by the SSR Devices
synthetictest_config_probes
array
app name comes from customprobes above or /const/synthetictestprobes
org_setting_wan_pma
object
1 property
org_setting_security
object
3 properties
synthetictest_config_custom_probe_type
string
enum: application, curl, icmp, reachability, tcp
juniper_accounts
array
modified_time
number
When the object has been modified for the last time, in epoch
juniper_srx_auto_upgrade
object
autoupgrade device first time it is onboarded
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Juniper Mist AI 12
Other APIs Juniper Mist AI publishes across the network.
Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API
#Orgs Setting