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

Mist Orgs Setting API

API Calls to manage the Mist Organization Settings

Mist Orgs Setting API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Setting. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 126 schemas. It is described by OpenAPI 3.2.0, at version 2606.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

6 operations 4 paths 126 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Orgs Setting API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

Paths & Operations 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
getOrgSettings 1 param → 200400401403404429
PUT
/api/v1/orgs/{org_id}/setting
updateOrgSettings
updateOrgSettings 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/setting/blacklist
deleteOrgWirelessClientsBlocklist
deleteOrgWirelessClientsBlocklist 1 param → 200400401403404429
POST
/api/v1/orgs/{org_id}/setting/blacklist
createOrgWirelessClientsBlocklist
createOrgWirelessClientsBlocklist 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/setting/pcap_bucket/setup
setOrgCustomBucket
setOrgCustomBucket 1 param body → 200400401403404429
POST
/api/v1/orgs/{org_id}/setting/pcap_bucket/verify
verifyOrgCustomBucket
verifyOrgCustomBucket 1 param body → 200400401403404429

Schemas 126

The contract defines 126 schemas that model the data the API accepts and returns. The most detailed are org_setting (53 properties), org_setting_mist_nac (15 properties), org_setting_auto_assignment_rule (12 properties), org_setting_gateway_mgmt (6 properties). Each schema is shown below with its type and property counts.

pcap_bucket_verify
object
Request to verify ownership of a custom packet capture bucket
2 properties 2 required
setting_ssr
object
SSR management settings for device onboarding and connectivity
5 properties
synthetictest_config_probes
array
app name comes from customprobes above or /const/synthetictestprobes
org_id
string
Unique identifier of a Mist organization
org_setting_mist_nac_fingerprinting
object
Client fingerprinting settings used for Mist NAC policy enforcement
4 properties
simple_alert_dns_failure
object
Thresholds for DNS failure heuristic alerts
3 properties
time_of_day
string
any / HH:MM (24-hour format)
org_setting_gateway_mgmt_host_out_policies
object
Optional path preferences for gateway-originated management traffic; ECMP is used across available paths when no preference is specified
3 properties
setting_ssr_conductor_hosts
array
Conductor IP addresses or hostnames used by SSR devices
org_setting_auto_assignment_rule
object
Automatic assignment rule used by org settings
12 properties 1 required
strings
array
Unique string values returned or accepted by this schema
mxedge_mgmt_oob_ip_type6
string
enum: autoconf, dhcp, disabled, static
switch_auto_upgrade_custom_versions
object
Custom version to be used. The Property Key is the switch hardware and the property value is the firmware version
org_setting_mist_nac_idps
array
Identity provider realm mappings used by Mist NAC
synthetictest_config_lan_network
object
configure minis probes to be tested on lan networks of gateways
2 properties
msp_id
string
Managed service provider identifier
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
org_setting_auto_device_naming_rules
arraynull
Automatic device naming rules, or null when automatic naming is not configured
org_setting_installer_extra_site_ids
array
Additional site IDs that installers may access
marvis_self_driving
object
Self-driving network automation settings per domain
3 properties
org_setting_marvis
object
Organization settings for Marvis automation
2 properties
ssr_proxy
object
SSR proxy configuration to talk to Mist
2 properties
synthetictest_config_custom_probe
object
Custom probe definition for synthetic tests
4 properties
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
simple_alert_dhcp_failure
object
Thresholds for DHCP failure heuristic alerts
3 properties
gateway_mgmt_host_out_policy_syslog_servers
array
Per-server host-out path policies for gateway syslog traffic
response_http403
object
Standard HTTP 403 permission error response
1 property
org_setting_password_policy
object
Admin credential policy settings for the organization
5 properties
org_setting_mist_nac
object
Organization-level Mist NAC configuration
15 properties
org_setting_mgmt
object
Organization management connectivity settings
3 properties
org_setting_wan_pma
object
PMA feature settings for WAN Assurance
1 property
mxedge_mgmt
object
Management settings for a Mist Edge appliance
6 properties
juniper_account
object
Linked Juniper account available to the organization
2 properties
org_setting
object
Organization-wide feature, integration, management, and security settings
53 properties
juniper_accounts
array
Linked Juniper accounts available to the organization
mac_addresses_macs
array
Unique MAC addresses included in a request
org_setting_celona
object
Integration settings for Celona
2 properties
org_setting_pcap
object
Packet capture export settings for the organization
2 properties
org_setting_auto_deviceprofile_assignment
object
Automatic device profile assignment configuration
2 properties
ap_auto_upgrade_custom_versions
object
Per-AP-model firmware versions or channels used for auto-upgrade. Property key is the AP model name (e.g. "AP41"), value is the firmware version or release cha…
org_setting_gateway_mgmt_host_in_policy
object
Host-in access policy for a gateway management service
1 property
synthetictest_config_vlan
object
Deprecated VLAN-based synthetic test settings
4 properties
org_setting_installer
object
Organization-level permissions and grace period for installer workflows
4 properties
synthetictest_config_custom_probes
object
Custom probes to be used for synthetic tests
response_pcap_bucket_config
object
Result of a custom packet capture bucket setup or verification operation
2 properties
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
org_setting_junos_shell_access_write
string
enum: admin, viewer, none
radsec_certs_ap
array
RADSec certificates for AP
mxedge_mgmt_oob_ip_type
string
enum: dhcp, disabled, static
synthetictest_config_lan_networks
array
List of networks to be used for synthetic tests
org_setting_jcloud
object
JCloud integration settings for this Mist organization
3 properties
gateway_mgmt_host_out_policy_syslog_server
object
Per-syslog-server host-out path policy override
3 properties
juniper_srx_auto_upgrade
object
SRX firmware auto-upgrade settings applied when a device is first onboarded
4 properties
org_setting_gateway_mgmt_app_probing
object
Application probing settings for organization gateway management
1 property
created_time
number
When the object has been created, in epoch
optic_port_config_port
object
Per-interface optic port override settings
2 properties
org_setting_auto_site_assignment_src
string
enum: extip, dnssuffix, geoip, lldpportdesc, lldpsystemname, model, name, subnet
day_of_week
string
enum: any, fri, mon, sat, sun, thu, tue, wed
org_setting_gateway_mgmt_host_in_policies
object
Host-in access policies for gateway management services
2 properties
pcap_bucket
object
Request to configure a custom packet capture bucket
1 property 1 required
org_setting_mist_nac_fingerprinting_wireless_coa
string
Change of Authorization action sent to wireless clients when fingerprints change. enum: reauth, disconnect
org_setting_wireless_pma
object
PMA feature settings for Wireless Assurance
1 property
org_setting_jcloud_ra
object
JCloud Routing Assurance connexion
3 properties
marvis_self_driving_domain
object
Self-driving automation settings for one Marvis domain
1 property
synthetictest_config_custom_probe_type
string
enum: application, curl, icmp, reachability, tcp
org_setting_juniper_srx
object
Organization settings for Juniper SRX devices
1 property
org_setting_mist_nac_mdm
object
MDM (Mobile Device Management) CoA configuration
1 property
switch_auto_upgrade
object
Switch firmware auto-upgrade settings
3 properties
ssr_upgrade_channel
string
upgrade channel to follow. enum: alpha, beta, stable
org_setting_auto_device_naming_rule
object
Automatic device naming rule
5 properties
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
org_setting_auto_site_assignment
object
Automatic site assignment configuration for claimed devices
2 properties
synthetictest_config_aggressiveness
string
Aggressiveness level for a synthetic test. enum: auto, high, med, low
org_setting_api_policy
object
Organization API response policy for hiding secrets and passwords
2 properties
org_setting_security
object
Organization security controls for local SSH and FIPS zeroize access
3 properties
setting_ssr_auto_upgrade_custom_versions
object
Property key is the SSR model (e.g. "SSR130").
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
synthetictest_config
object
Synthetic test configuration for Marvis Minis
6 properties
org_setting_junos_shell_access_helpdesk
string
enum: admin, viewer, none
id
string
Unique ID of the object instance in the Mist Organization
synthetictest_config_vlan_vlan_ids
array
VLAN identifiers where deprecated VLAN-based synthetic probes run
gateway_mgmt_host_out_policy_syslog
object
Host-out path policy for gateway syslog traffic
2 properties
synthetictest_config_vlans
array
Deprecated VLAN-based synthetic test configurations
simple_alert_arp_failure
object
Thresholds for ARP failure heuristic alerts
3 properties
org_setting_cloudshark
object
Packet capture integration settings for CloudShark
2 properties
org_setting_auto_device_naming_rule_src
string
Device attribute used to generate the name. enum: lldpportdesc, mac
org_setting_mist_nac_idp
object
Mist NAC identity provider realm mapping
3 properties
simple_alert
object
Heuristic alert thresholds used when a Marvis subscription is unavailable
3 properties
synthetictest_config_vlan_custom_test_urls
array
Deprecated custom URLs tested by VLAN-based synthetic probes
org_setting_junos_shell_access_read
string
enum: admin, viewer, none
org_setting_auto_device_naming
object
Automatic device naming configuration for claimed devices
2 properties
org_setting_switch_mgmt
object
Organization-level switch management settings
1 property
mac_addresses
object
Request containing one or more MAC addresses
1 property 1 required
site_auto_upgrade_version
string
desired version. enum: beta, custom, stable
org_setting_device_cert
object
Optional common device certificate configuration for organization settings
2 properties
org_setting_auto_site_assignment_rules
arraynull
Automatic site assignment rules, or null when automatic assignment is not configured
org_setting_gateway_mgmt_overlay_ip
object
Overlay IP configuration used for gateway management traffic
2 properties
org_setting_wired_pma
object
PMA feature settings for Wired Assurance
1 property
org_setting_auto_upgrade
object
Organization-wide AP automatic firmware upgrade policy
5 properties
response_http400
object
Standard HTTP 400 bad request error response
1 property
org_setting_junos_shell_access_admin
string
enum: admin, viewer, none
account_juniper_info
object
Linked Juniper account information returned by the integration
1 property
org_setting_mist_nac_server_cert
object
RADIUS server certificate presented by Mist NAC during EAP-TLS
3 properties
org_setting_mgmt_mxtunnel_ids
array
Mist Tunnel IDs available for organization management connectivity
nac_coa_type
string
CoA type to send. enum: reauth, disconnect
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
juniper_srx_auto_upgrade_custom_versions
object
Property key is the SRX Hardware model (e.g. "SRX4600")
org_setting_tags
array
Labels associated with these organization settings
optic_port_config
object
Property key is the interface name or range (e.g. et-0/0/47, et-0/0/48-49)
modified_time
number
When the object has been modified for the last time, in epoch
org_setting_gateway_mgmt
object
Organization-level gateway management settings
6 properties
org_setting_vpn_options
object
Organization VPN behavior options
3 properties
setting_ssr_auto_upgrade
object
Automatic firmware upgrade settings applied when an SSR device is first onboarded
4 properties
response_http404
object
Standard HTTP 404 not found error response
1 property
synthetictest_config_lan_networks_networks
array
List of networks to be used for synthetic tests
app_probing_apps
array
Application keys from [List Applications](/operations/listApplications)
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
org_setting_auto_deviceprofile_assignment_rules
arraynull
Automatic device profile assignment rules, or null when automatic assignment is not configured
cacerts
array
List of PEM-encoded ca certs
gateway_mgmt_host_out_policy
object
Host-out path policy for gateway-originated management traffic
1 property
synthetictest_config_wan_speedtest
object
WAN speedtest scheduling settings for synthetic tests
2 properties
org_setting_cradlepoint
object
Read-only Cradlepoint integration settings stored for the organization
5 properties
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
device_type_default_ap
string
enum: ap, gateway, switch
org_setting_switch
object
Configuration defaults for switches in this organization
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-setting-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

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