openapi: 3.1.0 info: contact: email: tmunzer@juniper.net name: Thomas Munzer description: '> Version: **2604.1.1** > > Date: **May 13, 2026**
NOTE:
Some important API changes will be introduced. Please make sure to read the announcements
--- ## Additional Documentation * [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html) * [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html) * [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/) ## Helpful Resources * [API Sandbox and Exercises](https://api-class.mist.com/) * [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace) * [Python Script Examples](https://github.com/tmunzer/mist_library) * [API Demo Apps](https://apps.mist-lab.fr/) * [Juniper Blog](https://blogs.juniper.net/) ## Mist Web Browser Extension: * Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh) * Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/) ---' license: name: MIT url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE title: Mist Admins Orgs Setting API version: 2604.1.1 x-logo: altText: Juniper-MistAI backgroundColor: '#FFFFFF' url: https://www.mist.com/wp-content/uploads/logo.png servers: - description: Mist Global 01 url: https://api.mist.com - description: Mist Global 02 url: https://api.gc1.mist.com - description: Mist Global 03 url: https://api.ac2.mist.com - description: Mist Global 04 url: https://api.gc2.mist.com - description: Mist Global 05 url: https://api.gc4.mist.com - description: Mist EMEA 01 url: https://api.eu.mist.com - description: Mist EMEA 02 url: https://api.gc3.mist.com - description: Mist EMEA 03 url: https://api.ac6.mist.com - description: Mist EMEA 04 url: https://api.gc6.mist.com - description: Mist APAC 01 url: https://api.ac5.mist.com - description: Mist APAC 02 url: https://api.gc5.mist.com - description: Mist APAC 03 url: https://api.gc7.mist.com security: - apiToken: [] - basicAuth: [] - basicAuth: [] csrfToken: [] tags: - description: API Calls to manage the Mist Organization Settings name: Orgs Setting paths: /api/v1/orgs/{org_id}/setting: parameters: - $ref: '#/components/parameters/org_id' get: description: Get Org Settings operationId: getOrgSettings responses: '200': $ref: '#/components/responses/OrgSetting' '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: getOrgSettings tags: - Orgs Setting put: description: Update Org Settings operationId: updateOrgSettings requestBody: content: application/json: schema: $ref: '#/components/schemas/org_setting' description: Request Body responses: '200': content: application/json: examples: Example: value: auto_device_naming: enable: true rules: - match_device: ap prefix: MIST- src: lldp_port_desc auto_deviceprofile_assignment: enable: true rules: - expression: string model: string prefix: string src: name subnet: string suffix: string value: string auto_site_assignment: enable: true rules: - expression: string model: string prefix: string src: name subnet: string suffix: string value: string cacerts: - string cloudshark: apitoken: string url: string device_cert: cert: string key: string disable_pcap: true installer: allow_all_sites: true extra_site_ids: - b069b358-4c97-5319-1f8c-7c5ca64d6ab1 grace_period: 0 mgmt: mxtunnel_ids: - b069b358-4c97-5319-1f8c-7c5ca64d6ab1 use_mxtunnel: true use_wxtunnel: true modified_time: 0 msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string password_policy: enabled: true expiry_in_days: 365 min_length: 8 requires_special_char: true requires_two_factor_auth: true pcap: bucket: string max_pkt_len: 0 pcap_bucket_verified: true remote_syslog: enabled: true send_to_all_servers: true servers: - facility: change-log host: string port: 0 protocol: udp severity: critical tag: string security: disable_local_ssh: true fips_zeroize_password: string limit_ssh_access: true tags: - string ui_idle_timeout: 0 schema: $ref: '#/components/schemas/org_setting' description: OK '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: updateOrgSettings tags: - Orgs Setting /api/v1/orgs/{org_id}/setting/blacklist: parameters: - $ref: '#/components/parameters/org_id' delete: description: Delete Org Blacklist Station Clients operationId: deleteOrgWirelessClientsBlocklist responses: '200': $ref: '#/components/responses/OK' '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: deleteOrgWirelessClientsBlocklist tags: - Orgs Setting post: description: "Create Org Blacklist Client List. \n\nIf there is already a blacklist, this API will replace it with the new one. \n\nMax number of blacklist clients is 1000. \n\nRetrieve the current blacklisted clients from `blacklist_url` under Org:Setting\n" operationId: createOrgWirelessClientsBlocklist requestBody: content: application/json: examples: Example: value: macs: - 18-65-90-de-f4-c6 - 84-89-ad-5d-69-0d schema: $ref: '#/components/schemas/mac_addresses' description: Request Body responses: '200': $ref: '#/components/responses/MacsArray' '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: createOrgWirelessClientsBlocklist tags: - Orgs Setting /api/v1/orgs/{org_id}/setting/pcap_bucket/setup: parameters: - $ref: '#/components/parameters/org_id' post: description: 'Provide Customer Bucket Name Setting up Custom PCAP Bucket Involves the following: * provide the bucket name * we’ll attempt to write a file MIST_TOKEN * you have to verify the ownership of the bucket by providing the content of the MIST_TOKEN' operationId: setOrgCustomBucket requestBody: content: application/json: examples: Example: value: bucket: company-private-pcap schema: $ref: '#/components/schemas/pcap_bucket' description: Request Body responses: '200': $ref: '#/components/responses/PcapBucketConfig' '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: setOrgCustomBucket tags: - Orgs Setting /api/v1/orgs/{org_id}/setting/pcap_bucket/verify: parameters: - $ref: '#/components/parameters/org_id' post: description: 'Verify Customer PCAP Bucket **Note**: If successful, a "VERIFIED" file will be created in the bucket' operationId: verifyOrgCustomBucket requestBody: content: application/json: examples: Example: value: bucket: company-private-pcap verify_token: eyJhbGciOiJIUzI1J9.eyJzdWIiOiIxMjM0joiMjgxOG5MDIyfQ.2rzcRvMA3Eg09NnjCAC-1EWMRtxAnFDM schema: $ref: '#/components/schemas/pcap_bucket_verify' description: Request Body responses: '200': $ref: '#/components/responses/OK' '400': $ref: '#/components/responses/HTTP400' '401': $ref: '#/components/responses/HTTP401' '403': $ref: '#/components/responses/HTTP403' '404': $ref: '#/components/responses/HTTP404' '429': $ref: '#/components/responses/HTTP429' summary: verifyOrgCustomBucket tags: - Orgs Setting components: schemas: synthetictest_config_custom_probe: additionalProperties: false properties: aggressiveness: $ref: '#/components/schemas/synthetictest_config_aggressiveness' target: description: Can be URL (e.g. http://x.com, https://x.com:8080/path/to/resource), IP address, or IP:port combination examples: - 10.3.5.3:8080 type: string threshold: description: In milliseconds examples: - 100 type: integer type: $ref: '#/components/schemas/synthetictest_config_custom_probe_type' type: object switch_auto_upgrade_custom_versions: additionalProperties: type: string description: Custom version to be used. The Property Key is the switch hardware and the property value is the firmware version examples: - QFX5120-32C: 23.4R2-S2.1 QFX5130-32CD: 23.4R2-S2.3 type: object org_setting_junos_shell_access_read: default: none description: 'enum: `admin`, `viewer`, `none`' enum: - admin - none - viewer type: string simple_alert_dhcp_failure: additionalProperties: false properties: client_count: default: 10 type: integer duration: default: 10 description: failing within minutes maximum: 60 minimum: 5 type: integer incident_count: default: 20 type: integer type: object time_of_day: default: any description: '`any` / HH:MM (24-hour format)' examples: - '12:00' type: string strings: items: type: string type: array uniqueItems: true account_juniper_info: properties: accounts: $ref: '#/components/schemas/juniper_accounts' type: object org_setting_gateway_mgmt_host_in_policy: additionalProperties: false properties: tenants: $ref: '#/components/schemas/strings' type: object app_probing_apps: description: APp-keys from [List Applications](/#operations/listApplications) examples: - - facebook items: type: string type: array marvis_self_driving: additionalProperties: false description: Self-driving network automation settings per domain properties: wan: $ref: '#/components/schemas/marvis_self_driving_domain' wired: $ref: '#/components/schemas/marvis_self_driving_domain' wireless: $ref: '#/components/schemas/marvis_self_driving_domain' type: object juniper_srx_auto_upgrade_custom_versions: additionalProperties: description: Firmware version to deploy on the specified SRX hardware examples: - 23.4R2-S2.1 type: string description: Property key is the SRX Hardware model (e.g. "SRX4600") type: object idp_machine_cert_lookup_field: default: automatic description: 'allow customer to choose the EAP-TLS client certificate''s field to use for IDP Machine Groups lookup. enum: `automatic`, `cn`, `dns`' enum: - automatic - cn - dns type: string synthetictest_config_aggressiveness: default: auto description: 'enum: `auto`, `high`, `low`' enum: - auto - high - med - low type: string synthetictest_config_vlan_vlan_ids: examples: - - 10 - 20 - '{{vlan}}' items: $ref: '#/components/schemas/vlan_id_with_variable' type: array org_setting_auto_deviceprofile_assignment: additionalProperties: false properties: enable: type: boolean rules: $ref: '#/components/schemas/org_setting_auto_deviceprofile_assignment_rules' type: object optic_port_config: additionalProperties: $ref: '#/components/schemas/optic_port_config_port' description: Property key is the interface name or range (e.g. `et-0/0/47`, `et-0/0/48-49`) type: object org_setting_jcloud: additionalProperties: false properties: org_apitoken: description: JCloud Org Token type: string org_apitoken_name: description: JCloud Org Token Name type: string org_id: description: JCloud Org ID type: string type: object ssr_proxy: additionalProperties: false description: SSR proxy configuration to talk to Mist properties: disabled: default: false examples: - true type: boolean url: examples: - https://proxy.corp.com:8080/ type: string type: object org_setting_cloudshark: additionalProperties: false properties: apitoken: examples: - accbd6f10c6d05c3 type: string url: description: If using CS Enterprise examples: - https://cloudshark.hosted.domain type: string type: object org_setting_mist_nac_fingerprinting_wireless_coa: description: 'enum: `reauth`, `disconnect`' enum: - reauth - disconnect type: string radsec_certs_ap: description: RADSec certificates for AP items: examples: - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----' type: string type: array org_setting_junos_shell_access_helpdesk: default: none description: 'enum: `admin`, `viewer`, `none`' enum: - admin - none - viewer type: string pcap_bucket_verify: properties: bucket: examples: - company-private-pcap type: string verify_token: examples: - eyJhbGciOiJIUzI1J9.eyJzdWIiOiIxMjM0joiMjgxOG5MDIyfQ.2rzcRvMA3Eg09NnjCAC-1EWMRtxAnFDM type: string required: - bucket - verify_token type: object cacerts: description: List of PEM-encoded ca certs items: examples: - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----' type: string type: array org_setting_gateway_mgmt_overlay_ip: additionalProperties: false properties: ip: description: When it's going overlay, a routable IP to overlay will be required type: string node1_ip: description: For SSR HA cluster, another IP for node1 will be required, too type: string type: object org_setting_gateway_mgmt_app_probing: additionalProperties: false properties: apps: $ref: '#/components/schemas/app_probing_apps' type: object org_setting_wireless_pma: additionalProperties: false properties: enabled: default: true type: boolean type: object gateway_mgmt_host_out_policy: additionalProperties: false properties: path_preference: type: string type: object org_setting_celona: additionalProperties: false properties: api_key: examples: - $2a$04$OkaLCoJn6rDjR8ha.oduQVDST3.kJNIrte type: string api_prefix: examples: - cc3273fcb016470e type: string type: object org_setting_installer_extra_site_ids: items: examples: - 4ac1dcf4-9d8b-7211-65c4-057819f0862b format: uuid type: string type: array response_http401: additionalProperties: false properties: detail: examples: - Authentication credentials were not provided. type: string type: object org_setting_auto_assignment_rule: additionalProperties: false description: Auto_rules in org settings properties: create_new_site_if_needed: default: false description: If `src`==`geoip`. By default, a claimed device only gets assigned if the site exists to auto-create the site, enable this type: boolean expression: description: "If `src`==`name`, `src`==`lldp_system_name`, `src`==`dns_suffix` \n \"[0:3]\" // \"abcdef\" -> \"abc\" \n \"split(.)[1]\" // \"a.b.c\" -> \"b\" \n \"split(-)[1][0:3]\" // \"a1234-b5678-c90\" -> \"b56\"'" examples: - split(.)[1] type: - string - 'null' gatewaytemplate_id: description: If `src`==`geoip` and `create_new_site_if_needed`==`true`. If a gateway template is desired for this newly created site type: string match_country: description: If `src`==`geoip` type: string match_device_type: $ref: '#/components/schemas/device_type_default_ap' match_model: description: Optional/additional filter type: string model: description: If `src`==`model` type: string prefix: description: If `src`==`name` examples: - XX- type: - string - 'null' src: $ref: '#/components/schemas/org_setting_auto_site_assignment_src' subnet: description: If `src`==`subnet` or `ext_ip`==`ext_ip` type: string suffix: description: If `src`==`name` examples: - -YY type: - string - 'null' value: description: "If \n * `src`==`ext_ip`, `src`==`subnet` or `src`==`model`, the site name\n * `src`==`geoip`: site name for the device to be assigned to (\\\"city\\\" / \\\"city+country\\\" / ...)\"" type: string required: - src type: object org_setting_auto_device_naming: additionalProperties: false properties: enable: type: boolean rules: $ref: '#/components/schemas/org_setting_auto_device_naming_rules' type: object org_setting_switch_mgmt: additionalProperties: false properties: ap_affinity_threshold: default: 12 description: If the field is set in both site/setting and org/setting, the value from site/setting will be used. examples: - 10 type: integer type: object org_setting_pcap: additionalProperties: false properties: bucket: examples: - myorg_pcap type: string max_pkt_len: default: 128 description: Max_len of non-management packets to capture examples: - 128 maximum: 128 type: integer type: object org_setting_junos_shell_access_write: default: admin description: 'enum: `admin`, `viewer`, `none`' enum: - admin - none - viewer type: string simple_alert: additionalProperties: false description: 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 encountering over X failures properties: arp_failure: $ref: '#/components/schemas/simple_alert_arp_failure' dhcp_failure: $ref: '#/components/schemas/simple_alert_dhcp_failure' dns_failure: $ref: '#/components/schemas/simple_alert_dns_failure' type: object synthetictest_config_lan_networks_networks: description: List of networks to be used for synthetic tests examples: - - pos-stations - pos-machines items: type: string type: array org_setting_gateway_mgmt: additionalProperties: false properties: app_probing: $ref: '#/components/schemas/org_setting_gateway_mgmt_app_probing' app_usage: description: consumes uplink bandwidth, requires WA license type: boolean fips_enabled: default: false type: boolean host_in_policies: $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policies' host_out_policies: $ref: '#/components/schemas/org_setting_gateway_mgmt_host_out_policies' overlay_ip: $ref: '#/components/schemas/org_setting_gateway_mgmt_overlay_ip' type: object org_setting_mist_nac_fingerprinting: additionalProperties: false description: Allows customer to enable client fingerprinting for policy enforcement properties: enabled: default: false description: enable/disable writes to NAC DDB fingerprint table type: boolean generate_coa: default: false description: enable/disable CoA triggers on fingerprint change for wired clients, always port-bounce type: boolean generate_wireless_coa: default: false description: enable/disable CoA triggers on fingerprint change for wireless clients type: boolean wireless_coa_type: $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting_wireless_coa' type: object org_setting_tags: description: List of tags items: type: string type: array org_setting_junos_shell_access: additionalProperties: false description: "junos_shell_access: Manages role-based web-shell access. \nWhen junos_shell access is not defined (Default) - No additional users are configured and web-shell uses default `mist` user to login. \nWhen junos_shell_access is defined - Additional users mist-web-admin (admin permission), mist-web-viewer(viewer permission) are configured on the device and web-shell logs in with the mist-web-admin/mist-web-viewer user depending upon the shell access level. Setting the shell access level to \"none\", disables web-shell access for that specific role.\n" properties: admin: $ref: '#/components/schemas/org_setting_junos_shell_access_admin' helpdesk: $ref: '#/components/schemas/org_setting_junos_shell_access_helpdesk' read: $ref: '#/components/schemas/org_setting_junos_shell_access_read' write: $ref: '#/components/schemas/org_setting_junos_shell_access_write' type: object pcap_bucket: properties: bucket: examples: - company-private-pcap type: string required: - bucket type: object org_setting_junos_shell_access_admin: default: admin description: 'enum: `admin`, `viewer`, `none`' enum: - admin - none - viewer type: string org_setting_api_policy: additionalProperties: false properties: no_reveal: default: false description: "By default, API hides password/secrets when the user doesn't have write access\n * `true`: API will hide passwords/secrets for all users\n * `false`: API will hide passwords/secrets for read-only users" type: boolean type: object vlan_id_with_variable: oneOf: - type: string - maximum: 4094 minimum: 1 type: integer org_setting_mist_nac_server_cert: additionalProperties: false description: radius server cert to be presented in EAP TLS properties: cert: examples: - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----' type: string key: examples: - '-----BEGIN PRI...' type: string password: description: private key password (optional) type: string type: object org_setting_auto_device_naming_rules: items: $ref: '#/components/schemas/org_setting_auto_device_naming_rule' type: - array - 'null' org_setting_mist_nac_idp: additionalProperties: false properties: exclude_realms: $ref: '#/components/schemas/org_setting_mist_nac_idp_exclude_realms' id: $ref: '#/components/schemas/id' user_realms: $ref: '#/components/schemas/org_setting_mist_nac_idp_user_realms' type: object org_setting_mist_nac_mdm: additionalProperties: false description: MDM (Mobile Device Management) CoA configuration properties: coa_type: $ref: '#/components/schemas/nac_coa_type' type: object org_setting_marvis: additionalProperties: false properties: self_driving: $ref: '#/components/schemas/marvis_self_driving' type: object gateway_mgmt_host_out_policy_syslog_server: additionalProperties: false description: Allows to define the host_out_policy per Syslog Server. The Property key is the Syslog name properties: host: examples: - 103.35.3.5 type: string path_preference: examples: - dc_only type: string server_name: examples: - dc_syslog_server type: string type: object msp_id: examples: - b9d42c2e-88ee-41f8-b798-f009ce7fe909 format: uuid readOnly: true type: string simple_alert_arp_failure: additionalProperties: false properties: client_count: default: 10 type: integer duration: default: 20 description: failing within minutes maximum: 60 minimum: 5 type: integer incident_count: default: 10 type: integer type: object org_setting_auto_deviceprofile_assignment_rules: items: $ref: '#/components/schemas/org_setting_auto_assignment_rule' type: - array - 'null' org_setting_jcloud_ra: additionalProperties: false description: JCloud Routing Assurance connexion properties: org_apitoken: description: JCloud Routing Assurance Org Token type: string org_apitoken_name: description: JCloud Routing Assurance Org Token Name type: string org_id: description: JCloud Routing Assurance Org ID type: string type: object created_time: description: When the object has been created, in epoch format: double readOnly: true type: number synthetictest_config: additionalProperties: false properties: aggressiveness: $ref: '#/components/schemas/synthetictest_config_aggressiveness' custom_probes: $ref: '#/components/schemas/synthetictest_config_custom_probes' disabled: default: false type: boolean lan_networks: $ref: '#/components/schemas/synthetictest_config_lan_networks' vlans: $ref: '#/components/schemas/synthetictest_config_vlans' wan_speedtest: $ref: '#/components/schemas/synthetictest_config_wan_speedtest' type: object org_setting_mist_nac_ip_version: default: v4 description: 'by default, NAS devices(switches/aps) and proxies(mxedge) are configured to reach mist-nac via IPv4. enum: `v4`, `v6`' enum: - v4 - v6 type: string mac_addresses_macs: examples: - - 683b679ac024 items: type: string minItems: 1 type: array uniqueItems: true org_setting_cradlepoint: additionalProperties: false properties: cp_api_id: examples: - 84446d61-2206-4ea5-855a-0043f980be54 readOnly: true type: string cp_api_key: examples: - 79c329da9893e34099c7d8ad5cb9c941 readOnly: true type: string ecm_api_id: examples: - 73446d61-2206-4ea5-855a-0043f980be62 readOnly: true type: string ecm_api_key: examples: - 68b329da9893e34099c7d8ad5cb9c940 readOnly: true type: string enable_lldp: readOnly: true type: boolean readOnly: true type: object org_setting_auto_site_assignment_rules: items: $ref: '#/components/schemas/org_setting_auto_assignment_rule' type: - array - 'null' org_setting_device_cert: additionalProperties: false description: common device cert, optional properties: cert: examples: - '-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----' type: string key: examples: - '-----BEGIN PRI...' type: string type: object mxedge_mgmt_oob_ip_type: default: dhcp description: 'enum: `dhcp`, `disabled`, `static`' enum: - dhcp - disabled - static type: string response_pcap_bucket_config: additionalProperties: false properties: bucket: type: string detail: type: string type: object setting_ssr_auto_upgrade_custom_versions: additionalProperties: description: Firmware version to deploy on the specified SSR model examples: - 6.3.0-107.r1 type: string description: Property key is the SSR model (e.g. "SSR130"). type: object synthetictest_config_wan_speedtest: additionalProperties: false properties: enabled: type: boolean time_of_day: $ref: '#/components/schemas/time_of_day' type: object org_setting_mgmt: additionalProperties: false description: management-related properties properties: mxtunnel_ids: $ref: '#/components/schemas/org_setting_mgmt_mxtunnel_ids' use_mxtunnel: default: false description: Whether to use Mist Tunnel for mgmt connectivity, this takes precedence over use_wxtunnel type: boolean use_wxtunnel: default: false description: Whether to use wxtunnel for mgmt connectivity type: boolean type: object org_setting_mist_nac_idp_user_realms: description: "Which realm should trigger this IDP. User Realm is extracted from:\n * Username-AVP (`mist.com` from john@mist.com)\n * Cert CN" items: examples: - abc type: string type: array mxedge_mgmt: additionalProperties: false properties: config_auto_revert: default: false type: boolean fips_enabled: default: false type: boolean mist_password: examples: - MIST_PASSWORD type: string oob_ip_type: $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type' oob_ip_type6: $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type6' root_password: examples: - ROOT_PASSWORD format: password type: string type: object mac_addresses: properties: macs: $ref: '#/components/schemas/mac_addresses_macs' required: - macs type: object setting_ssr: additionalProperties: false properties: auto_upgrade: $ref: '#/components/schemas/setting_ssr_auto_upgrade' conductor_hosts: $ref: '#/components/schemas/setting_ssr_conductor_hosts' conductor_token: description: Token to be used by the SSR Devices to connect to the Conductor type: string disable_stats: description: Disable stats collection on SSR devices type: boolean proxy: $ref: '#/components/schemas/ssr_proxy' type: object org_setting_mgmt_mxtunnel_ids: description: List of Mist Tunnels items: examples: - 08cd7499-5841-51c8-e663-fb16b6f3b45e format: uuid type: string type: array synthetictest_config_custom_probes: additionalProperties: $ref: '#/components/schemas/synthetictest_config_custom_probe' description: Custom probes to be used for synthetic tests type: object org_setting_mist_nac_idps: items: $ref: '#/components/schemas/org_setting_mist_nac_idp' type: array nac_coa_type: default: reauth description: 'CoA type to send. enum: `reauth`, `disconnect`' enum: - reauth - disconnect type: string org_setting_wired_pma: additionalProperties: false properties: enabled: default: false type: boolean type: object response_http429: additionalProperties: false properties: detail: examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold type: string type: object mxedge_mgmt_oob_ip_type6: default: autoconf description: 'enum: `autoconf`, `dhcp`, `disabled`, `static`' enum: - autoconf - dhcp - disabled - static type: string org_setting_mist_nac: additionalProperties: false properties: allow_teap_machine_auth_only: default: false description: allow clients to connect even when the user cert failed. TEAP authenticates both Machine Cert and User Cert. When enabled, clients who only succeed Machine Cert authentication will be accepted. type: boolean cacerts: $ref: '#/components/schemas/cacerts' default_idp_id: description: use this IDP when no explicit realm present in the incoming username/CN OR when no IDP is explicitly mapped to the incoming realm. type: string disable_rsae_algorithms: default: false description: to disable RSAE_PSS_SHA256, RSAE_PSS_SHA384, RSAE_PSS_SHA512 from server side. see https://www.openssl.org/docs/man3.0/man1/openssl-ciphers.html type: boolean eap_ssl_security_level: default: 2 description: eap ssl security level, see https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_security_level.html#DEFAULT-CALLBACK-BEHAVIOUR maximum: 4 minimum: 1 type: integer eu_only: default: false description: By default, NAC POD failover considers all NAC pods available around the globe, i.e. EU, US, or APAC based, failover happens based on geo IP of the originating site. For strict GDPR compliance NAC POD failover would only happen between the PODs located within the EU environment, and no authentication would take place outside of EU. This is an org setting that is applicable to WLANs, switch templates, mxedge clusters that have mist_nac enabled type: boolean fingerprinting: $ref: '#/components/schemas/org_setting_mist_nac_fingerprinting' idp_machine_cert_lookup_field: $ref: '#/components/schemas/idp_machine_cert_lookup_field' idp_user_cert_lookup_field: $ref: '#/components/schemas/idp_user_cert_lookup_field' idps: $ref: '#/components/schemas/org_setting_mist_nac_idps' mdm: $ref: '#/components/schemas/org_setting_mist_nac_mdm' server_cert: $ref: '#/components/schemas/org_setting_mist_nac_server_cert' use_ip_version: $ref: '#/components/schemas/org_setting_mist_nac_ip_version' use_ssl_port: default: false description: By default, NAS devices (switches/aps) and proxies(mxedge) are configured to use port TCP2083(RadSec) to reach mist-nac. Set `use_ssl_port`==`true` to override that port with TCP43 (ssl), This is an org level setting that is applicable to wlans, switch_templates, and mxedge_clusters that have mist-nac enabled type: boolean usermac_expiry: default: 0 description: Allow customer to configure an expiry time for usermacs by attaching a Quarantine label to those which have been inactive for the configured period of time (in days). 0 means no expiry examples: - 30 maximum: 1095 minimum: 0 type: integer type: object ssr_upgrade_channel: default: stable description: 'upgrade channel to follow. enum: `alpha`, `beta`, `stable`' enum: - alpha - beta - stable type: string org_setting_auto_device_naming_rule_src: description: 'enum: `lldp_port_desc`, `mac`' enum: - lldp_port_desc - mac type: string org_setting: description: Org Settings properties: allow_mist: default: false description: whether to allow Mist to look at this org type: boolean ap_updown_threshold: default: 0 description: Enable threshold-based device down delivery for AP devices only. When configured it takes effect for AP devices and `device_updown_threshold` is ignored. examples: - null maximum: 240 minimum: 0 type: - integer - 'null' api_policy: $ref: '#/components/schemas/org_setting_api_policy' auto_device_naming: $ref: '#/components/schemas/org_setting_auto_device_naming' auto_deviceprofile_assignment: $ref: '#/components/schemas/org_setting_auto_deviceprofile_assignment' auto_site_assignment: $ref: '#/components/schemas/org_setting_auto_site_assignment' blacklist_url: examples: - https://papi.s3.amazonaws.com/blacklist/xxx... readOnly: true type: string cacerts: $ref: '#/components/schemas/radsec_certs_ap' celona: $ref: '#/components/schemas/org_setting_celona' cloudshark: $ref: '#/components/schemas/org_setting_cloudshark' cradlepoint: $ref: '#/components/schemas/org_setting_cradlepoint' created_time: $ref: '#/components/schemas/created_time' device_cert: $ref: '#/components/schemas/org_setting_device_cert' device_updown_threshold: default: 0 description: "Enable threshold-based device down delivery via\n * device-updowns webhooks topic, \n * Mist Alert Framework; e.g. send AP/SW/GW down event only if AP/SW/GW Up is not seen within the threshold in minutes; 0 - 240, default is 0 (trigger immediate)" maximum: 240 minimum: 0 type: - integer - 'null' disable_pcap: default: false description: Whether to disallow Mist to analyze pcap files (this is required for marvis pcap) type: boolean disable_remote_shell: default: false description: Whether to disable remote shell access for an entire org type: boolean for_site: readOnly: true type: boolean gateway_mgmt: $ref: '#/components/schemas/org_setting_gateway_mgmt' gateway_tunnel_updown_threshold: description: enable threshold-based gateway tunnel (secure edge tunnels) up-down delivery. examples: - null minimum: 0 type: - integer - 'null' gateway_updown_threshold: default: 0 description: Enable threshold-based device down delivery for Gateway devices only. When configured it takes effect for GW devices and `device_updown_threshold` is ignored. examples: - 10 maximum: 240 minimum: 0 type: - integer - 'null' id: $ref: '#/components/schemas/id' installer: $ref: '#/components/schemas/org_setting_installer' jcloud: $ref: '#/components/schemas/org_setting_jcloud' jcloud_ra: $ref: '#/components/schemas/org_setting_jcloud_ra' juniper: $ref: '#/components/schemas/account_juniper_info' juniper_srx: $ref: '#/components/schemas/org_setting_juniper_srx' junos_shell_access: $ref: '#/components/schemas/org_setting_junos_shell_access' marvis: $ref: '#/components/schemas/org_setting_marvis' mgmt: $ref: '#/components/schemas/org_setting_mgmt' mist_nac: $ref: '#/components/schemas/org_setting_mist_nac' modified_time: $ref: '#/components/schemas/modified_time' msp_id: $ref: '#/components/schemas/msp_id' mxedge_mgmt: $ref: '#/components/schemas/mxedge_mgmt' optic_port_config: $ref: '#/components/schemas/optic_port_config' org_id: $ref: '#/components/schemas/org_id' password_policy: $ref: '#/components/schemas/org_setting_password_policy' pcap: $ref: '#/components/schemas/org_setting_pcap' pcap_bucket_verified: readOnly: true type: boolean security: $ref: '#/components/schemas/org_setting_security' simple_alert: $ref: '#/components/schemas/simple_alert' ssr: $ref: '#/components/schemas/setting_ssr' switch: $ref: '#/components/schemas/org_setting_switch' switch_mgmt: $ref: '#/components/schemas/org_setting_switch_mgmt' switch_updown_threshold: default: 0 description: Enable threshold-based device down delivery for Switch devices only. When configured it takes effect for SW devices and `device_updown_threshold` is ignored. examples: - 0 type: - integer - 'null' synthetic_test: $ref: '#/components/schemas/synthetictest_config' tags: $ref: '#/components/schemas/org_setting_tags' ui_idle_timeout: default: 0 description: Automatically logout the user when UI session is inactive. `0` means disabled examples: - 10 maximum: 480 minimum: 0 type: integer ui_no_tracking: default: false type: boolean vpn_options: $ref: '#/components/schemas/org_setting_vpn_options' wan_pma: $ref: '#/components/schemas/org_setting_wan_pma' wired_pma: $ref: '#/components/schemas/org_setting_wired_pma' wireless_pma: $ref: '#/components/schemas/org_setting_wireless_pma' type: object gateway_mgmt_host_out_policy_syslog: additionalProperties: false properties: path_preference: examples: - broadband_wans type: string servers: $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog_servers' type: object org_id: examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 format: uuid readOnly: true type: string org_setting_switch: additionalProperties: false properties: auto_upgrade: $ref: '#/components/schemas/switch_auto_upgrade' type: object synthetictest_config_vlan: additionalProperties: false properties: custom_test_urls: $ref: '#/components/schemas/synthetictest_config_vlan_custom_test_urls' disabled: default: false description: For some vlans where we don't want this to run type: boolean probes: $ref: '#/components/schemas/synthetictest_config_probes' vlan_ids: $ref: '#/components/schemas/synthetictest_config_vlan_vlan_ids' type: object id: description: Unique ID of the object instance in the Mist Organization examples: - 53f10664-3ce8-4c27-b382-0ef66432349f format: uuid readOnly: true type: string simple_alert_dns_failure: additionalProperties: false properties: client_count: default: 20 type: integer duration: default: 10 description: failing within minutes maximum: 60 minimum: 5 type: integer incident_count: default: 30 type: integer type: object org_setting_auto_site_assignment: additionalProperties: false properties: enable: type: boolean rules: $ref: '#/components/schemas/org_setting_auto_site_assignment_rules' type: object marvis_self_driving_domain: additionalProperties: false properties: enabled: default: false type: boolean type: object response_http403: additionalProperties: false properties: detail: examples: - You do not have permission to perform this action. type: string type: object synthetictest_config_vlan_custom_test_urls: deprecated: true examples: - - https://www.abc.com/ - https://10.3.5.1:8080/about items: type: string type: array idp_user_cert_lookup_field: default: automatic description: 'allow customer to choose the EAP-TLS client certificate''s field. To use for IDP User Groups lookup. enum: `automatic`, `cn`, `email`, `upn`' enum: - automatic - cn - email - upn type: string switch_auto_upgrade: additionalProperties: false properties: custom_versions: $ref: '#/components/schemas/switch_auto_upgrade_custom_versions' enabled: description: Enable auto upgrade for the switch type: boolean snapshot: default: false description: Enable snapshot during the upgrade process type: boolean type: object org_setting_installer: additionalProperties: false properties: allow_all_devices: type: boolean allow_all_sites: type: boolean extra_site_ids: $ref: '#/components/schemas/org_setting_installer_extra_site_ids' grace_period: type: integer type: object org_setting_gateway_mgmt_host_in_policies: additionalProperties: false properties: icmp: $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy' snmp: $ref: '#/components/schemas/org_setting_gateway_mgmt_host_in_policy' type: object optic_port_config_port: additionalProperties: false properties: channelized: default: false description: Enable channelization type: boolean speed: description: Interface speed (e.g. `25g`, `50g`), use the chassis speed by default examples: - 25g type: string type: object org_setting_auto_site_assignment_src: description: 'enum: `ext_ip`, `dns_suffix`, `geoip`, `lldp_port_desc`, `lldp_system_name`, `model`, `name`, `subnet`' enum: - ext_ip - dns_suffix - geoip - lldp_port_desc - lldp_system_name - model - name - subnet type: string org_setting_mist_nac_idp_exclude_realms: description: When the IDP of mxedge_proxy type, exclude the following realms from proxying in addition to other valid home realms in this org items: type: string type: array gateway_mgmt_host_out_policy_syslog_servers: items: $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog_server' type: array response_http404: additionalProperties: false properties: id: type: string type: object org_setting_password_policy: additionalProperties: false description: password policy properties: enabled: default: false description: Whether the policy is enabled type: boolean expiry_in_days: description: Password expiry in days. Password Expiry Notice banner will display in the UI 14 days before expiration examples: - 60 maximum: 365 minimum: 1 type: integer min_length: default: 8 description: Required password length type: integer requires_special_char: default: false description: Whether to require special character type: boolean requires_two_factor_auth: default: false description: Whether to require two-factor auth type: boolean type: object org_setting_auto_device_naming_rule: additionalProperties: false properties: expression: description: "\"[0:3]\" // \"abcdef\" -> \"abc\" \n \"split(.)[1]\" // \"a.b.c\" -> \"b\" \n \"split(-)[1][0:3]\" // \"a1234-b5678-c90\" -> \"b56\"'" examples: - split(.)[1] type: string match_device: $ref: '#/components/schemas/device_type_default_ap' prefix: description: Prefix to append to the device name type: string src: $ref: '#/components/schemas/org_setting_auto_device_naming_rule_src' suffix: description: Suffix to append to the device name type: string type: object response_http400: additionalProperties: false properties: detail: examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' type: string type: object device_type_default_ap: default: ap description: 'enum: `ap`, `gateway`, `switch`' enum: - ap - gateway - switch type: string juniper_account: additionalProperties: false properties: linked_by: examples: - John Smith (john@abccorp.com) readOnly: true type: string name: examples: - ABC Corp readOnly: true type: string type: object synthetictest_config_lan_networks: description: List of networks to be used for synthetic tests items: $ref: '#/components/schemas/synthetictest_config_lan_network' type: array synthetictest_config_lan_network: additionalProperties: false description: configure minis probes to be tested on lan networks of gateways properties: networks: $ref: '#/components/schemas/synthetictest_config_lan_networks_networks' probes: $ref: '#/components/schemas/synthetictest_config_probes' type: object org_setting_gateway_mgmt_host_out_policies: additionalProperties: false description: '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: dns/mist/ntp/pim' properties: dns: $ref: '#/components/schemas/gateway_mgmt_host_out_policy' ntp: $ref: '#/components/schemas/gateway_mgmt_host_out_policy' syslog: $ref: '#/components/schemas/gateway_mgmt_host_out_policy_syslog' type: object org_setting_vpn_options: additionalProperties: false properties: as_base: maximum: 2147483647 minimum: 1 type: integer enable_ipv6: default: false type: boolean st_subnet: default: 10.224.0.0/12 description: requiring /12 or bigger to support 16 private IPs for 65535 gateways type: string type: object org_setting_juniper_srx: additionalProperties: false properties: auto_upgrade: $ref: '#/components/schemas/juniper_srx_auto_upgrade' type: object setting_ssr_auto_upgrade: additionalProperties: false description: auto_upgrade device first time it is onboarded properties: channel: $ref: '#/components/schemas/ssr_upgrade_channel' custom_versions: $ref: '#/components/schemas/setting_ssr_auto_upgrade_custom_versions' enabled: default: false type: boolean version: description: Firmware version to deploy (e.g. 6.3.0-107.r1). Optional, used when custom_versions not specified examples: - 6.3.0-107.r1 type: string type: object synthetictest_config_vlans: deprecated: true items: $ref: '#/components/schemas/synthetictest_config_vlan' type: array setting_ssr_conductor_hosts: description: List of Conductor IP Addresses or Hosts to be used by the SSR Devices items: type: string type: array synthetictest_config_probes: description: app name comes from `custom_probes` above or /const/synthetic_test_probes items: type: string type: array org_setting_wan_pma: additionalProperties: false properties: enabled: default: false type: boolean type: object org_setting_security: additionalProperties: false properties: disable_local_ssh: description: Whether to disable local SSH (by default, local SSH is enabled with allow_mist in Org is enabled type: boolean fips_zeroize_password: description: password required to zeroize devices (FIPS) on site level examples: - NUKETHESITE type: string limit_ssh_access: default: false description: Whether to allow certain SSH keys to SSH into the AP (see Site:Setting) type: boolean type: object synthetictest_config_custom_probe_type: default: icmp description: 'enum: `application`, `curl`, `icmp`, `reachability`, `tcp`' enum: - application - curl - icmp - reachability - tcp type: string juniper_accounts: items: $ref: '#/components/schemas/juniper_account' type: array modified_time: description: When the object has been modified for the last time, in epoch format: double readOnly: true type: number juniper_srx_auto_upgrade: additionalProperties: false description: auto_upgrade device first time it is onboarded properties: custom_versions: $ref: '#/components/schemas/juniper_srx_auto_upgrade_custom_versions' enabled: default: false type: boolean snapshot: default: false type: boolean version: description: Firmware version to deploy (e.g. 23.4R2-S5.5). Optional, used when custom_versions not specified examples: - 23.4R2-S5.5 type: string type: object parameters: org_id: in: path name: org_id required: true schema: examples: - 000000ab-00ab-00ab-00ab-0000000000ab format: uuid type: string examples: HTTP403Example: value: detail: You do not have permission to perform this action. OrgSettingExample2: value: auto_device_naming: enable: true rules: - expression: '...' src: lldp_port_desc auto_deviceprofile_assignment: enable: true auto_site_assignment: enable: true rules: - expression: '[0:3]' prefix: XX- src: name suffix: -YY - src: subnet subnet: 10.1.2.0/18 value: s1351 - expression: '...' src: lldp_system_name - expression: '...' src: dns_suffix - model: AP41 src: model value: s1351 cacerts: - '-----BEGIN CERTIFICATE----- MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE -----END CERTIFICATE-----' - '-----BEGIN CERTIFICATE----- BhMCRVMxFDASBgNVBAoMC1N0YXJ0Q29tIENBMSwwKgYDVn-----END CERTIFICATE-----' cloudshark: apitoken: accbd6f10c6d05c3 url: https://cloudshark.hosted.domain device_cert: cert: '-----BEGIN CERTIFICATE----- MIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE -----END CERTIFICATE-----' key: '-----BEGIN PRI...' device_updown_threshold: 0 disable_pcap: false installer: allow_all_sites: false extra_site_ids: - 4ac1dcf4-9d8b-7211-65c4-057819f0862b - 52f4347e-3e4b-186c-21ca-ad5b70eb23d6 grace_period: 14 mgmt: mxtunnel_ids: - 08cd7499-5841-51c8-e663-fb16b6f3b45e use_mxtunnel: true use_wxtunnel: false password_policy: enabled: true expiry_in_days: 60 min_length: 8 requires_special_char: false requires_two_factor_auth: true pcap: bucket: myorg_pcap max_pkt_len: 128 pcap_bucket_verified: true remote_syslog: enabled: true send_to_all_servers: true servers: - facility: any host: syslogd.internal port: 514 protocol: udp severity: info tag: '' security: disable_local_ssh: false fips_zeroize_password: NUKETHESITE limit_ssh_access: false tags: - beta ui_idle_timeout: 10 MacsArrayExample: value: macs: - 18-65-90-de-f4-c6 - 84-89-ad-5d-69-0d HTTP429Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold HTTP400Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' PcapBucketConfigSuccess: value: {} HTTP401Example: value: detail: Authentication credentials were not provided. PcapBucketConfigFailed: value: bucket: company-private-pcap detail: failed to write bucket - 403 AccessDenied OrgSettingExample: value: auto_device_naming: enable: true rules: - match_device: ap prefix: MIST- src: lldp_port_desc auto_deviceprofile_assignment: enable: true rules: - expression: string model: string prefix: string src: name subnet: string suffix: string value: string auto_site_assignment: enable: true rules: - expression: string model: string prefix: string src: name subnet: string suffix: string value: string cacerts: - string cloudshark: apitoken: string url: string created_time: 0 device_cert: cert: string key: string device_updown_threshold: 0 disable_pcap: true id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 installer: allow_all_sites: true extra_site_ids: - b069b358-4c97-5319-1f8c-7c5ca64d6ab1 grace_period: 0 mgmt: mxtunnel_ids: - b069b358-4c97-5319-1f8c-7c5ca64d6ab1 use_mxtunnel: true use_wxtunnel: true modified_time: 0 msp_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1 name: string password_policy: enabled: true expiry_in_days: 180 min_length: 8 requires_special_char: true requires_two_factor_auth: true pcap: bucket: string max_pkt_len: 0 pcap_bucket_verified: true remote_syslog: enabled: true send_to_all_servers: true servers: - facility: conflict-log host: string port: 0 protocol: udp severity: any tag: string security: disable_local_ssh: true fips_zeroize_password: string limit_ssh_access: true tags: - string ui_idle_timeout: 0 responses: HTTP403: content: application/json: examples: Example: $ref: '#/components/examples/HTTP403Example' schema: $ref: '#/components/schemas/response_http403' application/vnd.api+json: examples: Example: $ref: '#/components/examples/HTTP403Example' schema: $ref: '#/components/schemas/response_http403' description: Permission Denied OK: description: OK HTTP401: content: application/json: examples: Example: $ref: '#/components/examples/HTTP401Example' schema: $ref: '#/components/schemas/response_http401' application/vnd.api+json: examples: Example: $ref: '#/components/examples/HTTP401Example' schema: $ref: '#/components/schemas/response_http401' description: Unauthorized OrgSetting: content: application/json: examples: Example: $ref: '#/components/examples/OrgSettingExample' Example2: $ref: '#/components/examples/OrgSettingExample2' schema: $ref: '#/components/schemas/org_setting' application/vnd.api+json: examples: Example: $ref: '#/components/examples/OrgSettingExample' Example2: $ref: '#/components/examples/OrgSettingExample2' schema: $ref: '#/components/schemas/org_setting' description: OK HTTP404: content: application/json: schema: $ref: '#/components/schemas/response_http404' application/vnd.api+json: schema: $ref: '#/components/schemas/response_http404' description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist MacsArray: content: application/json: examples: Example: $ref: '#/components/examples/MacsArrayExample' schema: $ref: '#/components/schemas/mac_addresses' application/vnd.api+json: examples: Example: $ref: '#/components/examples/MacsArrayExample' schema: $ref: '#/components/schemas/mac_addresses' description: OK HTTP429: content: application/json: examples: Example: $ref: '#/components/examples/HTTP429Example' schema: $ref: '#/components/schemas/response_http429' application/vnd.api+json: examples: Example: $ref: '#/components/examples/HTTP429Example' schema: $ref: '#/components/schemas/response_http429' description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold PcapBucketConfig: content: application/json: examples: Failed: $ref: '#/components/examples/PcapBucketConfigFailed' Success: $ref: '#/components/examples/PcapBucketConfigSuccess' schema: $ref: '#/components/schemas/response_pcap_bucket_config' application/vnd.api+json: examples: Failed: $ref: '#/components/examples/PcapBucketConfigFailed' Success: $ref: '#/components/examples/PcapBucketConfigSuccess' schema: $ref: '#/components/schemas/response_pcap_bucket_config' description: OK HTTP400: content: application/json: examples: Example: $ref: '#/components/examples/HTTP400Example' schema: $ref: '#/components/schemas/response_http400' application/vnd.api+json: examples: Example: $ref: '#/components/examples/HTTP400Example' schema: $ref: '#/components/schemas/response_http400' description: Bad Syntax securitySchemes: apiToken: description: "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 equal or less privileges.\n\n**Format**:\n API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information." in: header name: Authorization type: apiKey basicAuth: description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth. scheme: basic type: http csrfToken: description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```" in: header name: X-CSRFToken type: apiKey