api.json

{"paths": {"api": {"paths": {"v1": {"paths": {"const": {"paths": {"alarm_defs": {"specs": {"get": {"description": "Get List of brief definitions of all the supported alarm types.\n\nThe example field contains an example payload as you would recieve in the alarm webhook output.\n\n\nHA cluster node names will be specified in the `node` field, if applicable.'", "operationId": "listAlarmDefinitions", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-alarm-definitions"}}}, "ap_channels": {"specs": {"get": {"description": "Get List of List of Available channels per country code", "operationId": "listApChannels", "parameters": [{"$ref": "#/components/parameters/country_code"}], "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-ap-channels"}}}, "ap_led_status": {"specs": {"get": {"description": "Get List of AP LED definition", "operationId": "listApLedDefinition", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-ap-led-definition"}}}, "app_categories": {"specs": {"get": {"description": "Get List of definitions of all the supported Application Categories. The example field contains an example payload as you would recieve in the alarm webhook output.", "operationId": "listAppCategoryDefinitions", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-app-category-definitions"}}}, "app_subcategories": {"specs": {"get": {"description": "Get List of definitions of all the supported Application sub-categories. The example field contains an example payload as you would recieve in the alarm webhook output.", "operationId": "listAppSubCategoryDefinitions", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-app-sub-category-definitions"}}}, "applications": {"specs": {"get": {"description": "Get List of a list of applications that Juniper-Mist APs recognize", "operationId": "listApplications", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-applications"}}}, "client_events": {"specs": {"get": {"description": "Get List of List of available Client Events", "operationId": "listClientEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-client-events-definitions"}}}, "countries": {"specs": {"get": {"description": "Get List of available Country Codes", "operationId": "listCountryCodes", "parameters": [{"description": "will include more country codes if true", "in": "query", "name": "extend", "schema": {"default": false, "type": "boolean"}}], "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-country-codes"}}}, "default_gateway_config": {"specs": {"get": {"description": "Generate Default Gateway Config", "operationId": "getGatewayDefaultConfig", "parameters": [{"description": "model the default gateway config is intended (as the default LAN/WAN port can differ)", "in": "query", "name": "model", "required": true, "schema": {"type": "string"}}, {"description": "whether the config is intended for HA", "in": "query", "name": "ha", "schema": {"type": "string"}}], "tags": ["Constants Models"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/models/get-gateway-default-config"}}}, "device_events": {"specs": {"get": {"description": "Get list of available Device Events", "operationId": "listDeviceEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-device-events-definitions"}}}, "device_models": {"specs": {"get": {"description": "Get list of AP device models for the Mist Site", "operationId": "listDeviceModels", "tags": ["Constants Models"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/models/list-device-models"}}}, "gateway_applications": {"specs": {"get": {"description": "Get the full list of applications that we recognize", "operationId": "listGatewayApplications", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-gateway-applications"}}}, "insight_metrics": {"specs": {"get": {"description": "List Insight Metrics", "operationId": "listInsightMetrics", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-insight-metrics"}}}, "languages": {"specs": {"get": {"description": "Get List of Languages", "operationId": "listSiteLanguages", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-site-languages"}}}, "license_types": {"specs": {"get": {"description": "Get License Types", "operationId": "getLicenseTypes", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/get-license-types"}}}, "marvisclient_versions": {"specs": {"get": {"description": "Get List of the available Marvis Client Versions.", "operationId": "listMarvisClientVersions", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-marvis-client-versions"}}}, "mxedge_events": {"specs": {"get": {"description": "Get List of available MX Edge Events", "operationId": "listMxEdgeEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-mx-edge-events-definitions"}}}, "mxedge_models": {"specs": {"get": {"description": "Get List of available Mx Edge models", "operationId": "listMxEdgeModels", "tags": ["Constants Models"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/models/list-mx-edge-models"}}}, "nac_events": {"specs": {"get": {"description": "Get List of List of available NAC Client Events", "operationId": "listNacEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-nac-events-definitions"}}}, "otherdevice_events": {"specs": {"get": {"description": "Supported Events Type", "operationId": "listOtherDeviceEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-other-device-events-definitions"}}}, "otherdevice_models": {"specs": {"get": {"description": "Supported OtherDevice Models", "operationId": "listSupportedOtherDeviceModels", "tags": ["Constants Models"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/models/list-supported-other-device-models"}}}, "states": {"specs": {"get": {"description": "Get List of ISO States based on country code", "operationId": "listStates", "parameters": [{"description": "country code, in [two-character](/#operations/listCountryCodes)", "in": "query", "name": "country_code", "required": true, "schema": {"type": "string"}}], "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-states"}}}, "system_events": {"specs": {"get": {"description": "Get List of List of available System Events", "operationId": "listSystemEventsDefinitions", "tags": ["Constants Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/events/list-system-events-definitions"}}}, "traffic_types": {"specs": {"get": {"description": "Get List of identified traffic", "operationId": "listTrafficTypes", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-traffic-types"}}}, "webhook_topics": {"specs": {"get": {"description": "Get List of the available Webhook Topics.", "operationId": "listWebhookTopics", "tags": ["Constants Definitions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/constants/definitions/list-webhook-topics"}}}}}, "installer": {"paths": {"orgs": {"paths": {"{org_id}": {"paths": {"alarmtemplates": {"specs": {"get": {"description": "Get List of alarm templates", "operationId": "listInstallerAlarmTemplates", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-alarm-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "deviceprofiles": {"specs": {"get": {"description": "Get List of Device Profiles", "operationId": "listInstallerDeviceProfiles", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}], "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-device-profiles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "devices": {"specs": {"get": {"description": "Get List of recently claimed devices", "operationId": "listInstallerListOfRenctlyClaimedDevices", "parameters": [{"description": "Device Model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "Site Name", "in": "query", "name": "site_name", "schema": {"type": "string"}}, {"description": "Site ID", "in": "query", "name": "site_id", "schema": {"format": "uuid", "type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-list-of-renctly-claimed-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "This mirrors `POST /api/v1/orgs/{org_id}/inventory` (see Inventory API)", "operationId": "claimInstallerDevices", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//claim-installer-devices"}}, "paths": {"{device_mac}": {"specs": {"delete": {"description": "Unassign recently claimed devices", "operationId": "unassignInstallerRecentlyClaimedDevice", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//unassign-installer-recently-claimed-device"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "put": {"description": "Provision or Replace a device \n\nIf replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with mac replacing_mac) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned.", "operationId": "provisionInstallerDevices", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//provision-installer-devices"}}, "paths": {"locate": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Locate a Device by blinking it\u2019s LED, it\u2019s a persisted state that has to be stopped by calling Stop Locating API", "operationId": "startInstallerLocateDevice", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//start-installer-locate-device"}}}, "unlocate": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Stop it", "operationId": "stopInstallerLocateDevice", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//stop-installer-locate-device"}}}, "{image_name}": {"specs": {"delete": {"description": "delete image", "operationId": "deleteInstallerDeviceImage", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//delete-installer-device-image"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/image_name"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Add image", "operationId": "addInstallerDeviceImage", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//add-installer-device-image"}}}}}, "{fpc0_mac}": {"paths": {"vc": {"specs": {"get": {"description": "Get VC Status\n\nThe API returns a combined view of the VC status which includes topology and stats", "operationId": "getInstallerDeviceVirtualChassis", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//get-installer-device-virtual-chassis"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"description": "FPC0 MAC Address", "in": "path", "name": "fpc0_mac", "required": true, "schema": {"type": "string"}}], "post": {"description": "For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory.\n\nIn case that the user would like to choose the dedicated switch as a VC master. Or for EX2300-C-12P and EX2300-C-12T which doesn\u2019t have dedicated VC ports, below are procedures to automate the VC creation:\n\n1. Power on the switch that is choosen as the VC master first. And the powering on the other member switches.\n2. Claim or adopt all these switches under the same organization\u2019s Inventory\n3. Assign these switches into the same Site\n4. Invoke vc command on the switch choosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.\n5. Connect the cables to the VC ports for these switches\n6. Wait for the VC to be formed. The Org\u2019s inventory will be updated for the new VC.", "operationId": "createInstallerVirtualChassis", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//create-installer-virtual-chassis"}, "put": {"description": "The VC creation and adding member switch API will update the device\u2019 s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config.\n\nIn this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change.\n\nNotice: to configure preprovisioned VC, every member of the VC must be in the inventory.\n\n## Add new members\nFor models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory.\n\nFor EX2300 VC, adding new members requires to follow the procedures below:\n1. Powering on the new member switches and ensuring cables are not connected to any VC ports.\n2. Claim or adopt all new member switches under the VC\u2019s organization Inventory\n3. Assign all new member switches to the same Site as the VC\n4. Invoke vc command to add switches to the VC.\n5. Connect the cables to the VC ports for these switches\n6. After a while, the Org\u2019s Inventory shows this new switches has been added into the VC.\n\n## Removing member switch\nTo remove a member switch from the VC, following the procedures below:\n\n1. Ensuring the VC is connected to the cloud first\n2. Unplug the cable from the VC port of the switch\n3. Waiting for the VC state (vc_state) of this switch is changed to not-present\n4. Invoke update_vc with remove to remove this switch from the VC\n5. The Org\u2019s Inventory shows the switch is removed.\n\nPlease notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unpluging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happened, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again.\n\n## Renumber a member switch\nWhen a member switch doesn\u2019 t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported:\n\n1. Replace a non-fpc0 member switch\n2. Replace fpc0. When fpc0 is relaced, PAPI device config and JUNOS config will be both updated.\n\nFor renumber to work, the following procedures are needed: \n1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. \n2. Adding the new member switch to the VC \n3. Waiting for the VC state (vc_state) of this VC to be updated to API server \n4. Invoke vc with renumber to replace the new member switch from fpc X to\n\n## Perprovision VC members\nBy specifying \u201cpreprovision\u201d op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change.\n\nNote: \n1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added \n2. New VC members to be added should exist in the same Site as the VC\n\nUpdate Device\u2019s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.", "operationId": "updateInstallerVirtualChassisMember", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//update-installer-virtual-chassis-member"}}}}}}}, "rftemplates": {"specs": {"get": {"description": "Get List of RF Templates", "operationId": "listInstallerRfTemplatesNames", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-rf-templates-names"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "sitegroups": {"specs": {"get": {"description": "Get List of Site Groups", "operationId": "listInstallerSiteGroups", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-site-groups"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "sites": {"specs": {"get": {"description": "Get List of Sites", "operationId": "listInstallerSites", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-sites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"{site_name}": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/site_name"}], "put": {"description": "Often the Installers are asked to assign Devices to Sites. The Sites can either be pre-created or created/modified by the Installer. If this is an update, the same grace period also applies.", "operationId": "createOrUpdateInstallerSites", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//create-or-update-installer-sites"}}, "paths": {"maps": {"specs": {"get": {"description": "Get List of Maps", "operationId": "listInstallerMaps", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//list-installer-maps"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/site_name"}]}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/site_name"}], "post": {"description": "Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign & place ap if name or mac matches", "operationId": "importInstallerMap", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//import-installer-map"}}}, "{map_id}": {"specs": {"delete": {"description": "Delete Map", "operationId": "deleteInstallerMap", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//delete-installer-map"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/site_name"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "Create a MAP", "operationId": "createInstallerMap", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//create-installer-map"}, "put": {"description": "Update map", "operationId": "updateInstallerMap", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//update-installer-map"}}}}}}}}}}}}}, "sites": {"paths": {"{site_name}": {"paths": {"optimize": {"specs": {"get": {"description": "After installation is considered complete (APs are placed on maps, all powered up), you can trigger an optimize operation where RRM will kick in (and maybe other things in the future) before it\u2019s automatically scheduled.", "operationId": "optimizeInstallerRrm", "tags": ["Installer"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/installer//optimize-installer-rrm"}, "parameters": [{"$ref": "#/components/parameters/site_name"}]}}}}}}}}, "invite": {"paths": {"verify": {"paths": {"{token}": {"specs": {"parameters": [{"$ref": "#/components/parameters/token"}], "post": {"description": "**Note**: another call to ```GET /api/v1/self``` is required to see the new set of privileges", "operationId": "verifyAdminInvite", "tags": ["Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins//verify-admin-invite"}}}}}}}, "login": {"specs": {"post": {"description": "Log in with email/password.\nWhen 2FA is enabled, there are two ways to login:\n1. login with two_factor token (with Google Authenticator, etc) \n2. login with email/password, generate the token, and use /login/two_factor with the token", "operationId": "login", "tags": ["Admins Login"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/login/login"}}, "paths": {"lookup": {"specs": {"post": {"description": "Login Lookup", "operationId": "lookup", "tags": ["Admins Lookup"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/lookup/lookup"}}}, "oauth": {"paths": {"{provider}": {"specs": {"delete": {"description": "Unlink OAuth2 Provider", "operationId": "unlinkOauth2Provider", "tags": ["Admins Login - OAuth2"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/login/oauth2/unlink-oauth2-provider"}, "get": {"description": "Obtain Authorization URL for Login", "operationId": "getOauth2AuthorizationUrlForLogin", "parameters": [{"description": "callback URL", "in": "query", "name": "forward", "schema": {"example": "http://manage.mist.com/oauth/callback.html", "type": "string"}}], "tags": ["Admins Login - OAuth2"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/login/oauth2/get-oauth2-authorization-url-for-login"}, "parameters": [{"in": "path", "name": "provider", "required": true, "schema": {"description": "Oauth2 provider name", "type": "string"}}], "post": {"description": "Login via OAuth2", "operationId": "loginOauth2", "tags": ["Admins Login - OAuth2"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/login/oauth2/login-oauth2"}}}}}, "two_factor": {"specs": {"post": {"description": "Send 2FA Code", "operationId": "twoFactor", "tags": ["Admins Login"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/login/two-factor"}}}}}, "logout": {"specs": {"post": {"description": "Logout", "operationId": "logout", "tags": ["Admins Logout"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/logout/logout"}}}, "mobile": {"paths": {"verify": {"paths": {"{secret}": {"specs": {"parameters": [{"$ref": "#/components/parameters/secret"}], "post": {"description": "Verify secret", "operationId": "activateSdkInvite", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/activate-sdk-invite"}}}}}}}, "msps": {"specs": {"post": {"description": "Create MSP account", "operationId": "createMsp", "tags": ["MSPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps//create-msp"}}, "paths": {"{msp_id}": {"specs": {"delete": {"description": "Deleting MSP removes the MSP and OrgGroup under the MSP as well as all privileges associated with them. It does not remove any Org or Admins", "operationId": "deleteMsp", "tags": ["MSPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps//delete-msp"}, "get": {"description": "Get MSP Detail", "operationId": "getMspDetails", "tags": ["MSPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps//get-msp-details"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "put": {"description": "Update MSP", "operationId": "updateMsp", "tags": ["MSPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps//update-msp"}}, "paths": {"admins": {"specs": {"get": {"description": "Get List of MSP Admins", "operationId": "listMspAdmins", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/list-msp-admins"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}, "paths": {"{admin_id}": {"specs": {"delete": {"description": "This removes all privileges this admin has against the MSP. This goes deep all the way to the sites", "operationId": "revokeMspAdmin", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/revoke-msp-admin"}, "get": {"description": "Get MSP Admins", "operationId": "getMspAdmin", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/get-msp-admin"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/admin_id"}], "put": {"description": "Update MSP Admin", "operationId": "updateMspAdmin", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/update-msp-admin"}}}}}, "claim": {"specs": {"parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Claim an Order by Activation Code", "operationId": "claimMspLicence", "tags": ["MSPs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/licenses/claim-msp-licence"}}}, "insights": {"paths": {"{metric}": {"specs": {"get": {"description": "Get MSP SLEs (all/worst Orgs ...)", "operationId": "getMspSle", "parameters": [{"description": "see /api/v1/const/insight_metrics for more details", "in": "query", "name": "sle", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}], "tags": ["MSPs SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sles/get-msp-sle"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/metric"}]}}}}, "inventory": {"paths": {"{device_mac}": {"specs": {"get": {"description": "Get Inventoy By device MAC address", "operationId": "getMspInventoryByMac", "tags": ["MSPs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/inventory/get-msp-inventory-by-mac"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/device_mac"}]}}}}, "invites": {"specs": {"parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Invite MSP Admin\n\n**Note**: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token", "operationId": "inviteMspAdmin", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/invite-msp-admin"}}, "paths": {"{invite_id}": {"specs": {"delete": {"description": "Delete admin invite", "operationId": "uninviteMspAdmin", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/uninvite-msp-admin"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/invite_id"}], "put": {"description": "Update MSP admin invite", "operationId": "updateMspAdminInvite", "tags": ["MSPs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/admins/update-msp-admin-invite"}}}}}, "licenses": {"specs": {"get": {"description": "Get List of Msp Licenses", "operationId": "listMspLicenses", "tags": ["MSPs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/licenses/list-msp-licenses"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "put": {"description": "Move or Delete MSP Licenses", "operationId": "moveOrDeleteMspLicenseToAnotherOrg", "tags": ["MSPs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/licenses/move-or-delete-msp-license-to-another-org"}}}, "logo": {"specs": {"delete": {"description": "Delete MSP Logo", "operationId": "deleteMspLogo", "tags": ["MSPs Logo"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/logo/delete-msp-logo"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Upload Logo (only for advanced msp tier)", "operationId": "postMspLogo", "tags": ["MSPs Logo"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/logo/post-msp-logo"}}}, "logs": {"specs": {"get": {"description": "Get list of change logs for the current MSP", "operationId": "listMspAuditLogs", "parameters": [{"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "admin name or email", "in": "query", "name": "admin_name", "schema": {"type": "string"}}, {"description": "message", "in": "query", "name": "message", "schema": {"type": "string"}}, {"description": "sort order", "in": "query", "name": "sort", "schema": {"$ref": "#/components/schemas/list_msp_logs_sort"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["MSPs Logs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/logs/list-msp-audit-logs"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Audit Logs", "operationId": "countMspAuditLogs", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/msp_logs_count_distinct"}}], "tags": ["MSPs Logs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/logs/count-msp-audit-logs"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}}}, "orggroups": {"specs": {"get": {"description": "Get List of MSP Org Groups", "operationId": "listMspOrgGroups", "tags": ["MSPs Org Groups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/org-groups/list-msp-org-groups"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Create MSP Org Group", "operationId": "createMspOrgGroup", "tags": ["MSPs Org Groups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/org-groups/create-msp-org-group"}}, "paths": {"{orggroup_id}": {"specs": {"delete": {"description": "Delete MSP Org Group", "operationId": "deleteMspOrgGroup", "tags": ["MSPs Org Groups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/org-groups/delete-msp-org-group"}, "get": {"description": "Get MSP Org Group Details", "operationId": "getMspOrgGroup", "tags": ["MSPs Org Groups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/org-groups/get-msp-org-group"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/orggroup_id"}], "put": {"description": "Update MSP Org Group", "operationId": "updateMspOrgGroup", "tags": ["MSPs Org Groups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/org-groups/update-msp-org-group"}}}}}, "orgs": {"specs": {"get": {"description": "Get List of MSP Orgs", "operationId": "listMspOrgs", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/list-msp-orgs"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Create an Org under MSP", "operationId": "createMspOrg", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/create-msp-org"}, "put": {"description": "Assign or Unassign Orgs to an MSP account", "operationId": "manageMspOrgs", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/manage-msp-orgs"}}, "paths": {"search": {"specs": {"get": {"description": "Search Org in MSP", "operationId": "searchMspOrgs", "parameters": [{"$ref": "#/components/parameters/name"}, {"description": "org id", "in": "query", "name": "org_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "if this org has sufficient subscription", "in": "query", "name": "sub_insufficient", "schema": {"type": "boolean"}}, {"description": "if this org is under trial period", "in": "query", "name": "trial_enabled", "schema": {"type": "boolean"}}, {"description": "a list of types that enabled by usage", "in": "query", "name": "usage_types", "schema": {"$ref": "#/components/schemas/strings"}}, {"$ref": "#/components/parameters/limit"}], "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/search-msp-orgs"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}, "{org_id}": {"specs": {"delete": {"description": "delete MSP Org", "operationId": "deleteMspOrg", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/delete-msp-org"}, "get": {"description": "Get MSP Org Details", "operationId": "getMspOrg", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/get-msp-org"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/org_id"}], "put": {"description": "Update MSP Org", "operationId": "updateMspOrg", "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/update-msp-org"}}}}}, "search": {"specs": {"get": {"description": "Search in MSP Orgs", "operationId": "searchMspOrgGroup", "parameters": [{"description": "orgs", "example": "orgs", "in": "query", "name": "type", "required": true, "schema": {"$ref": "#/components/schemas/msp_search_type"}}, {"$ref": "#/components/parameters/q"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["MSPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps//search-msp-org-group"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}, "ssoroles": {"specs": {"get": {"description": "Get List of MSP SSO Roles", "operationId": "listMspSsoRoles", "tags": ["MSPs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso-roles/list-msp-sso-roles"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Create MSP Role", "operationId": "createMspSsoRole", "tags": ["MSPs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso-roles/create-msp-sso-role"}}, "paths": {"{ssorole_id}": {"specs": {"delete": {"description": "Delete MSP SSO Roles", "operationId": "deleteMspSsoRole", "tags": ["MSPs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso-roles/delete-msp-sso-role"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/ssorole_id"}], "put": {"description": "Update SSO Role", "operationId": "updateMspSsoRole", "tags": ["MSPs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso-roles/update-msp-sso-role"}}}}}, "ssos": {"specs": {"get": {"description": "List MSP SSO Configs", "operationId": "listMspSsos", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/list-msp-ssos"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}], "post": {"description": "Create MSP SSO profile", "operationId": "createMspSso", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/create-msp-sso"}}, "paths": {"{sso_id}": {"specs": {"delete": {"description": "Delete MSP SSO Config", "operationId": "deleteMspSso", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/delete-msp-sso"}, "get": {"description": "Get MSP SSO Config", "operationId": "getMspSso", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/get-msp-sso"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/sso_id"}], "put": {"description": "Update MSP SSO config", "operationId": "updateMspSso", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/update-msp-sso"}}, "paths": {"failures": {"specs": {"get": {"description": "Get List of MSP SSO Latest Failures", "operationId": "listMspSsoLatestFailures", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/list-msp-sso-latest-failures"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/sso_id"}]}}, "metadata": {"specs": {"get": {"description": "Get MSP SAML Metadata", "operationId": "getMspSamlMetadata", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/get-msp-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/sso_id"}]}}, "metadata.xml": {"specs": {"get": {"description": "Download MSP SAML Metadata\n\nExample of metadata.xml:\n```xml\n<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" validUntil=\"2027-10-12T21:59:01Z\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">\n  <md:SPSSODescriptor AuthnRequestsSigned=\"false\" WantAssertionsSigned=\"true\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">\n      <md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/logout\" />\n      <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>\n      <md:AssertionConsumerService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" index=\"0\" isDefault=\"true\"/>\n      <md:AttributeConsumingService index=\"0\">\n          <md:ServiceName xml:lang=\"en-US\">Mist</md:ServiceName>\n          <md:RequestedAttribute Name=\"Role\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"true\"/>\n          <md:RequestedAttribute Name=\"FirstName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n          <md:RequestedAttribute Name=\"LastName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n      </md:AttributeConsumingService>\n  </md:SPSSODescriptor>\n</md:EntityDescriptor>\n```", "operationId": "downloadMspSamlMetadata", "tags": ["MSPs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/sso/download-msp-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}, {"$ref": "#/components/parameters/sso_id"}]}}}}}}, "stats": {"paths": {"licenses": {"specs": {"get": {"description": "Get List of MSP Licences", "operationId": "listMspOrgLicenses", "tags": ["MSPs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/licenses/list-msp-org-licenses"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}, "orgs": {"specs": {"get": {"description": "Get List of MSP Orgs Stats", "operationId": "listMspOrgStats", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["MSPs Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/orgs/list-msp-org-stats"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}}}, "suggestion": {"paths": {"count": {"specs": {"get": {"description": "Count Marvis actions", "operationId": "countMspsMarvisActions", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/msp_marvis_suggestions_count_distinct"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["MSPs Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/marvis/count-msps-marvis-actions"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}}}, "tickets": {"specs": {"get": {"description": "Get List of Tickets of a MSP", "operationId": "listMspTickets", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["MSPs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/tickets/list-msp-tickets"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count tickets", "operationId": "countMspTickets", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/msp_tickets_count_distinct"}}], "tags": ["MSPs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/msps/tickets/count-msp-tickets"}, "parameters": [{"$ref": "#/components/parameters/msp_id"}]}}}}}}}}, "orgs": {"specs": {"post": {"description": "Org admin can invite people to manage the org. Furthermore, he can dictate the level of security those accounts are. The check is enforced when the invited admin tries to \u201caccept\u201d the invitation and every time the admin tries to login", "operationId": "createOrg", "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//create-org"}}, "paths": {"{org_id}": {"specs": {"delete": {"description": "Delete Org", "operationId": "deleteOrg", "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//delete-org"}, "get": {"description": "Get Organization information", "operationId": "getOrg", "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//get-org"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "put": {"description": "Update Org", "operationId": "updateOrg", "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//update-org"}}, "paths": {"128routers": {"paths": {"register_cmd": {"specs": {"get": {"description": "128T devices can be managed/adopted by Mist.", "operationId": "getOrg128TRegistrationCommands", "tags": ["Orgs Devices - SSR"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/ssr/get-org128-t-registration-commands"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "admins": {"specs": {"get": {"description": "Get List of people who can manage the Site/Org under the Org", "operationId": "listOrgAdmins", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/list-org-admins"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"{admin_id}": {"specs": {"delete": {"description": "This removes all privileges this admin has against the org", "operationId": "revokeOrgAdmin", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/revoke-org-admin"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/admin_id"}], "put": {"description": "Invite Org Admin", "operationId": "updateOrgAdmin", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/update-org-admin"}}}}}, "alarms": {"paths": {"ack": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Ack multiple Org Alarms", "operationId": "ackOrgMultipleAlarms", "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/ack-org-multiple-alarms"}}}, "ack_all": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Ack all Org Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.", "operationId": "ackOrgAllAlarms", "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/ack-org-all-alarms"}}}, "count": {"specs": {"get": {"description": "Count Org Alarms", "operationId": "countOrgAlarms", "parameters": [{"in": "query", "name": "distinct", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/count-org-alarms"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Alarms", "operationId": "searchOrgAlarms", "parameters": [{"description": "site ID", "in": "query", "name": "site_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "alarm type", "in": "query", "name": "type", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/search-org-alarms"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "unack": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Unack multiple Org Alarms", "operationId": "unackOrgMultipleAlarms", "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/unack-org-multiple-alarms"}}}, "unack_all": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Unack all Org Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.", "operationId": "unackOrgAllArlarms", "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/unack-org-all-arlarms"}}}, "{alarm_id}": {"paths": {"ack": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/alarm_id"}], "post": {"description": "Ack Org Alarm", "operationId": "ackOrgAlarm", "tags": ["Orgs Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarms/ack-org-alarm"}}}}}}}, "alarmtemplates": {"specs": {"get": {"description": "Get List of Org Alarm Templates", "operationId": "listOrgAlarmTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/list-org-alarm-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Available rules can be found in Orgs>Consts>getAlarmDefs\n\nThe delivery dict is only required if different from the template delivery settings.", "operationId": "createOrgAlarmTemplate", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/create-org-alarm-template"}}, "paths": {"suppress": {"specs": {"delete": {"description": "Un-Suppress Suppressed Alarms", "operationId": "unsuppressOrgSuppressedAlarms", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/unsuppress-org-suppressed-alarms"}, "get": {"description": "Get List of Org Alarms Currently Suppressed", "operationId": "listOrgSuppressedAlarms", "parameters": [{"description": "returns both scopes if not specified", "in": "query", "name": "scope", "schema": {"$ref": "#/components/schemas/suppressed_alarm_scope"}}], "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/list-org-suppressed-alarms"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "In certain situations, for example, scheduled maintenance, you may want to suspend alarms to be triggered against Sites for a period of time.", "operationId": "suppressOrgAlarm", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/suppress-org-alarm"}}}, "{alarmtemplate_id}": {"specs": {"delete": {"description": "Delete Org Alarm Template", "operationId": "deleteOrgAlarmTemplate", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/delete-org-alarm-template"}, "get": {"description": "Get Org Alarm Template Details", "operationId": "getOrgAlarmTemplate", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/get-org-alarm-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/alarmtemplate_id"}], "put": {"description": "Update Org Alarm Template", "operationId": "updateOrgAlarmTemplate", "tags": ["Orgs Alarm Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/alarm-templates/update-org-alarm-template"}}}}}, "apitokens": {"specs": {"get": {"description": "Get List of Org API Tokens", "operationId": "listOrgApiTokens", "tags": ["Orgs API Tokens"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/api-tokens/list-org-api-tokens"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org API Token\nNote that the token key is only available during creation time.", "operationId": "createOrgApiToken", "tags": ["Orgs API Tokens"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/api-tokens/create-org-api-token"}}, "paths": {"{apitoken_id}": {"specs": {"delete": {"description": "Delete Org API Token", "operationId": "deleteOrgApiToken", "tags": ["Orgs API Tokens"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/api-tokens/delete-org-api-token"}, "get": {"description": "Get Org API Token", "operationId": "getOrgApiToken", "tags": ["Orgs API Tokens"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/api-tokens/get-org-api-token"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/apitoken_id"}], "put": {"description": "Update Org API Token", "operationId": "updateOrgApiToken", "tags": ["Orgs API Tokens"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/api-tokens/update-org-api-token"}}}}}, "aptemplates": {"specs": {"get": {"description": "Get List of Org AP Templates", "operationId": "listOrgAptemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/ap-templates/list-org-aptemplates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org AP Template", "operationId": "createOrgAptemplate", "tags": ["Orgs AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/ap-templates/create-org-aptemplate"}}, "paths": {"{aptemplate_id}": {"specs": {"delete": {"description": "Delete existing AP Template", "operationId": "deleteOrgAptemplate", "tags": ["Orgs AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/ap-templates/delete-org-aptemplate"}, "get": {"description": "Get AP Template", "operationId": "getOrgAptemplate", "tags": ["Orgs AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/ap-templates/get-org-aptemplate"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/aptemplate_id"}], "put": {"description": "Update AP Template", "operationId": "updateOrgAptemplate", "tags": ["Orgs AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/ap-templates/update-org-aptemplate"}}}}}, "assetfilters": {"specs": {"get": {"description": "Get List of Org BLE asset filters. \nEach asset filter in the list operates independently. For a filter object to match an asset, all of the filter properties must match (logical \u2018AND\u2019 of each filter property). For example, the \u201cVisitor Tags\u201d filter below will match an asset when both the \u201cibeacon\\_uuid\u201d and \u201cibeacon_major\u201d properties match the asset. All non-matching assets are ignored.", "operationId": "listOrgAssetFilters", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/asset-filters/list-org-asset-filters"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Asset Filter\n\nCreates a single BLE asset filter for the given site. Any subset of filter properties can be included in the filter. A matching asset must meet the conditions of all given filter properties (logical \u2018AND\u2019).", "operationId": "createOrgAssetFilters", "tags": ["Orgs Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/asset-filters/create-org-asset-filters"}}, "paths": {"{assetfilter_id}": {"specs": {"delete": {"description": "Deletes an existing BLE asset filter for the given site.", "operationId": "deleteOrgAssetFilter", "tags": ["Orgs Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/asset-filters/delete-org-asset-filter"}, "get": {"description": "Get Org Asset Filter Details", "operationId": "getOrgAssetFilter", "tags": ["Orgs Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/asset-filters/get-org-asset-filter"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/assetfilter_id"}], "put": {"description": "Updates an existing BLE asset filter for the given site.", "operationId": "updateOrgAssetFilters", "tags": ["Orgs Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/asset-filters/update-org-asset-filters"}}}}}, "assets": {"specs": {"get": {"description": "Get List of Org Assets", "operationId": "listOrgAssets", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/list-org-assets"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Asset", "operationId": "createOrgAsset", "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/create-org-asset"}}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Impert Org Assets. \n\nIt can be done via a CSV file or a JSON payload.\n\n#### CSV File Format\n```csv\nname,mac\n\"asset_name\",5c5b53010101\n```", "operationId": "importOrgAssets", "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/import-org-assets"}}}, "{asset_id}": {"specs": {"delete": {"description": "Delete Org Asset", "operationId": "deleteOrgAsset", "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/delete-org-asset"}, "get": {"description": "Get Org Asset Details", "operationId": "getOrgAsset", "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/get-org-asset"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/asset_id"}], "put": {"description": "Update Org Asset", "operationId": "updateOrgAsset", "tags": ["Orgs Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/assets/update-org-asset"}}}}}, "avprofiles": {"specs": {"get": {"description": "Get List of Antivirus Profiles", "operationId": "listOrgAntivirusProfiles", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Antivirus Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/list-org-antivirus-profiles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create getOrgServices Antivirus Profile", "operationId": "createOrgAntivirusProfile", "tags": ["Orgs Antivirus Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/create-org-antivirus-profile"}}, "paths": {"{avprofiles_id}": {"specs": {"delete": {"description": "deleteOrgAntivirusProfile", "operationId": "deleteOrgAntivirusProfile", "tags": ["Orgs Antivirus Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/delete-org-antivirus-profile"}, "get": {"description": "Get Org Antivirus Profile", "operationId": "getOrgAntivirusProfile", "tags": ["Orgs Antivirus Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/get-org-antivirus-profile"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/avprofiles_id"}], "put": {"description": "update Org Antivirus Profile", "operationId": "updateOrgAntivirusProfile", "tags": ["Orgs Antivirus Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/antivirus-profiles/update-org-antivirus-profile"}}}}}, "cert": {"specs": {"get": {"description": "Get Org Certificates", "operationId": "getOrgCertificates", "tags": ["Orgs Cert"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cert/get-org-certificates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"regenerate": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Clear Org Certificates", "operationId": "clearOrgCertificates", "tags": ["Orgs Cert"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cert/clear-org-certificates"}}}}}, "claim": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Claim Org licenses / activation codes", "operationId": "claimOrgLicense", "tags": ["Orgs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/licenses/claim-org-license"}}}, "clients": {"paths": {"count": {"specs": {"get": {"description": "Count Org Wireless Clients", "operationId": "countOrgWirelessClients", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_clients_count_distinct"}}, {"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "device type, e.g. Mac, Nvidia, iPhone", "in": "query", "name": "device", "schema": {"type": "string"}}, {"description": "os, e.g. Sierra, Yosemite, Windows 10", "in": "query", "name": "os", "schema": {"type": "string"}}, {"description": "model, e.g. \u201cMBP 15 late 2013\u201d, 6, 6s, \u201c8+ GSM\u201d", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "AP mac where the client has connected to", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "vlan", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/ip"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wireless/count-org-wireless-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "events": {"paths": {"search": {"specs": {"get": {"description": "Get Org Clients Events", "operationId": "searchOrgWirelessClientEvents", "parameters": [{"$ref": "#/components/parameters/client_event_type"}, {"description": "for assoc/disassoc events", "in": "query", "name": "reason_code", "schema": {"type": "integer"}}, {"description": "SSID Name", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_proto"}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wireless/search-org-wireless-client-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Org Wireless Clients", "operationId": "searchOrgWirelessClients", "parameters": [{"description": "Site ID", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/ip"}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "Radio band. enum: `24`, `5`, `6`", "in": "query", "name": "band", "schema": {"type": "string"}}, {"description": "device type, e.g. Mac, Nvidia, iPhone", "in": "query", "name": "device", "schema": {"type": "string"}}, {"description": "only available for clients running the Marvis Client app, os, e.g. Sierra, Yosemite, Windows 10", "in": "query", "name": "os", "schema": {"type": "string"}}, {"description": "only available for clients running the Marvis Client app, model, e.g. \u201cMBP 15 late 2013\u201d, 6, 6s, \u201c8+ GSM\u201d", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "AP mac where the client has connected to", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/psk_id_query"}, {"description": "only available for clients using PPSK authentication, the Name of the PSK", "in": "query", "name": "psk_name", "schema": {"type": "string"}}, {"description": "only available for clients using 802.1X authentication, partial / full username", "in": "query", "name": "username", "schema": {"type": "string"}}, {"description": "vlan", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "partial / full MAC address, hostname, username, psk_name or ip", "in": "query", "name": "text", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wireless/search-org-wireless-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "sessions": {"paths": {"count": {"specs": {"get": {"description": "Count Org Wireless Clients Sessions", "operationId": "countOrgWirelessClientsSessions", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_client_sessions_count_distinct"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "E.g. \u201cMac\u201d, \u201ciPhone\u201d, \u201cApple watch\u201d", "in": "query", "name": "client_family", "schema": {"type": "string"}}, {"description": "E.g. \u201cApple\u201d", "in": "query", "name": "client_manufacture", "schema": {"type": "string"}}, {"description": "E.g. \u201c8+\u201d, \u201cXS\u201d", "in": "query", "name": "client_model", "schema": {"type": "string"}}, {"description": "E.g. \u201cMojave\u201d, \u201cWindows 10\u201d, \u201cLinux\u201d", "in": "query", "name": "client_os", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wireless/count-org-wireless-clients-sessions"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Wireless Clients Sessions", "operationId": "searchOrgWirelessClientSessions", "parameters": [{"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "E.g. \u201cMac\u201d, \u201ciPhone\u201d, \u201cApple watch\u201d", "in": "query", "name": "client_family", "schema": {"type": "string"}}, {"description": "E.g. \u201cApple\u201d", "in": "query", "name": "client_manufacture", "schema": {"type": "string"}}, {"description": "E.g. \u201c8+\u201d, \u201cXS\u201d", "in": "query", "name": "client_model", "schema": {"type": "string"}}, {"description": "Username", "in": "query", "name": "client_username", "schema": {"type": "string"}}, {"description": "E.g. \u201cMojave\u201d, \u201cWindows 10\u201d, \u201cLinux\u201d", "in": "query", "name": "client_os", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/psk_id_query"}, {"description": "PSK Name", "in": "query", "name": "psk_name", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wireless/search-org-wireless-client-sessions"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "{client_mac}": {"paths": {"coa": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "Trigger a CoA (change of authorization) against a client", "operationId": "reauthOrgDot1xWirelessClient", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/reauth-org-dot1x-wireless-client"}}}}}}}, "clone": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create an Org by cloning from another one. Org Settings, Templates, Wxlan Tags, Wxlan Tunnels, Wxlan Rules, Org Wlans will be copied. Sites and Site Groups will not be copied, and therefore, the copied template will not be applied to any site/sitegroups.", "operationId": "cloneOrg", "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//clone-org"}}}, "crl": {"specs": {"get": {"description": "Get Org CRL File", "operationId": "getOrgCrlFile", "tags": ["Orgs CRL"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/crl/get-org-crl-file"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"truncate": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "By default, all certs used by recently unclaimed devices within 9 month will be included in CRL. If the list grows too big, you can truncate it", "operationId": "truncateOrgCrlFile", "tags": ["Orgs Cert"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cert/truncate-org-crl-file"}}}}}, "deviceprofiles": {"specs": {"get": {"description": "Get List of Org Device Profiles", "operationId": "listOrgDeviceProfiles", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/list-org-device-profiles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Device Profile", "operationId": "createOrgDeviceProfiles", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/create-org-device-profiles"}}, "paths": {"{deviceprofile_id}": {"specs": {"delete": {"description": "Delete Org Device Profile", "operationId": "deleteOrgDeviceProfile", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/delete-org-device-profile"}, "get": {"description": "Get Org device Profile Details", "operationId": "getOrgDeviceProfile", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/get-org-device-profile"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/deviceprofile_id"}], "put": {"description": "Update Org Device Profile", "operationId": "updateOrgDeviceProfile", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/update-org-device-profile"}}, "paths": {"assign": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/deviceprofile_id"}], "post": {"description": "Assign Org Device Profile to Devices", "operationId": "assignOrgDeviceProfile", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/assign-org-device-profile"}}}, "unassign": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/deviceprofile_id"}], "post": {"description": "Unassign Org Device Profile from Devices", "operationId": "unassignOrgDeviceProfile", "tags": ["Orgs Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/device-profiles/unassign-org-device-profile"}}}}}}}, "devices": {"specs": {"get": {"description": "Get List of Org Devices", "operationId": "listOrgDevices", "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/list-org-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count Org Devices", "operationId": "countOrgDevices", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_devices_count_distinct"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "for switches and gateways, to filter on managed/unmanaged devices. enum: `true`, `false`", "in": "query", "name": "managed", "schema": {"type": "string"}}, {"description": "AP mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/ip"}, {"description": "MxTunnel status, enum: `up`, `down`", "in": "query", "name": "mxtunnel_status", "schema": {"$ref": "#/components/schemas/count_org_devices_mxtunnel_status"}}, {"description": "Mist Edge id, if AP is connecting to a Mist Edge", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "LLDP system name", "in": "query", "name": "lldp_system_name", "schema": {"type": "string"}}, {"description": "LLDP system description", "in": "query", "name": "lldp_system_desc", "schema": {"type": "string"}}, {"description": "LLDP port id", "in": "query", "name": "lldp_port_id", "schema": {"type": "string"}}, {"description": "LLDP management ip address", "in": "query", "name": "lldp_mgmt_addr", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/count-org-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count Org Devices Events", "operationId": "countOrgDeviceEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_devices_events_count_distinct"}}, {"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "AP mac", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "AP Firmware", "in": "query", "name": "apfw", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "event message", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "event time", "in": "query", "name": "timestamp", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/device_event_type"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/count-org-device-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Devices Events", "operationId": "searchOrgDeviceEvents", "parameters": [{"description": "device mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "device_type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "event message", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "event time", "in": "query", "name": "timestamp", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/device_event_type"}, {"description": "Return last/recent event for passed in field", "example": "port_id", "in": "query", "name": "last_by", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/search-org-device-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "last_config": {"paths": {"count": {"specs": {"get": {"description": "Counts the number of entries in device config history for distinct field with given filters", "operationId": "countOrgDeviceLastConfigs", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_devices_last_configs_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/count-org-device-last-configs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Device Last Configs", "operationId": "searchOrgDeviceLastConfigs", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "Device MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Devices Name", "in": "query", "name": "name", "schema": {"type": "string"}}, {"description": "Device Version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/search-org-device-last-configs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "radio_macs": {"specs": {"get": {"description": "For some scenarios like E911 or security systems, the BSSIDs are required to identify which AP the client is connecting to. Then the location of the AP can be used as the approximate location of the client.\n\nEach radio MAC can have 16 BSSIDs (enumerate the last octet from 0-F)", "operationId": "listOrgApsMacs", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/list-org-aps-macs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Devices", "operationId": "searchOrgDevices", "parameters": [{"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "AP mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"description": "power_constrained", "in": "query", "name": "power_constrained", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/ip"}, {"description": "MxTunnel status, up / down", "in": "query", "name": "mxtunnel_status", "schema": {"$ref": "#/components/schemas/search_org_devices_mxtunnel_status"}}, {"description": "Mist Edge id, if AP is connecting to a Mist Edge", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "comma separated list of Mist Edge ids, if AP is connecting to a Mist Edge", "in": "query", "name": "mxedge_ids", "schema": {"type": "string"}}, {"description": "LLDP system name", "in": "query", "name": "lldp_system_name", "schema": {"type": "string"}}, {"description": "LLDP system description", "in": "query", "name": "lldp_system_desc", "schema": {"type": "string"}}, {"description": "LLDP port id", "in": "query", "name": "lldp_port_id", "schema": {"type": "string"}}, {"description": "LLDP management ip address", "in": "query", "name": "lldp_mgmt_addr", "schema": {"type": "string"}}, {"description": "bandwidth of band_24", "in": "query", "name": "band_24_bandwidth", "schema": {"type": "integer"}}, {"description": "bandwidth of band_5", "in": "query", "name": "band_5_bandwidth", "schema": {"type": "integer"}}, {"description": "bandwidth of band_6", "in": "query", "name": "band_6_bandwidth", "schema": {"type": "integer"}}, {"description": "Channel of band_24", "in": "query", "name": "band_24_channel", "schema": {"type": "integer"}}, {"description": "Channel of band_5", "in": "query", "name": "band_5_channel", "schema": {"type": "integer"}}, {"description": "Channel of band_6", "in": "query", "name": "band_6_channel", "schema": {"type": "integer"}}, {"description": "Port speed of eth0", "in": "query", "name": "eth0_port_speed", "schema": {"type": "integer"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/search-org-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "upgrade": {"specs": {"get": {"description": "Get List of Org multiple devces upgrades", "operationId": "listOrgDeviceUpgrades", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-org-device-upgrades"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Upgrade Multiple Sites (Only supported for Access Points ugprades)", "operationId": "upgradeOrgDevices", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-org-devices"}}, "paths": {"{upgrade_id}": {"specs": {"get": {"description": "Get Multiple Devices Upgrade", "operationId": "getOrgDeviceUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/get-org-device-upgrade"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/upgrade_id"}]}}}}, "versions": {"specs": {"get": {"description": "Get List of Available Device Versions", "operationId": "listOrgAvailableDeviceVersions", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "fetch version for device model, use/combine with `type` as needed (for switch and gateway devices)", "in": "query", "name": "model", "schema": {"type": "string"}}], "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-org-available-device-versions"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "events": {"paths": {"search": {"specs": {"get": {"description": "Search Org events\n\n\nSupported Event Types:\n- CRADLEPOINT_SYNC_FAILED\n- ORG_CA_CERT_ADDED\n- ORG_CA_CERT_REGENERATED", "operationId": "searchOrgEvents", "parameters": [{"description": "event type", "in": "query", "name": "type", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs//search-org-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "evpn_topologies": {"specs": {"get": {"description": "Get List of the existing Org EVPN topologies", "operationId": "listOrgEvpnTopologies", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/evpn-topologies/list-org-evpn-topologies"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "While all the `evpn_id` / `downlink_ips` can be specifidd by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you.\n\n**Notes:**\n1. You can use `core` / `distribution` / `access` to create a CLOS topology\n2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches\n3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN\n4. The API uses a few pre-defined parameters and best-practices to generate the configs. It can be customized by using `evpn_options` in Site Setting / Network Template. (e.g. a different subnet for the underlay)\n\n#### Collapsed Core\nIn a small-medium campus, EVPN can also be enabled only at the core switches (up to 4) by assigning all participating switches with `collapsed-core role`. When there are more than 2 switches, a ring-like topology will be formed.\n\n#### ESI-Lag\nIf the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches\n\n#### Leaf / Access / Collapsed-Core\nFor leaf nodes in a EVPN topology, you\u2019d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another", "operationId": "createOrgEvpnTopology", "tags": ["Orgs EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/evpn-topologies/create-org-evpn-topology"}}, "paths": {"{evpn_topology_id}": {"specs": {"delete": {"description": "Delete the Org EVPN Topology", "operationId": "deleteOrgEvpnTopology", "tags": ["Orgs EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/evpn-topologies/delete-org-evpn-topology"}, "get": {"description": "Get One EVPN Topology Detail", "operationId": "getOrgEvpnTopology", "tags": ["Orgs EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/evpn-topologies/get-org-evpn-topology"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/evpn_topology_id"}], "put": {"description": "Update the EVPN Topolgy", "operationId": "updateOrgEvpnTopology", "tags": ["Orgs EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/evpn-topologies/update-org-evpn-topology"}}}}}, "gatewaytemplates": {"specs": {"get": {"description": "Get List of Org Gateway Templates", "operationId": "listOrgGatewayTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/gateway-templates/list-org-gateway-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Gateway Template", "operationId": "createOrgGatewayTemplate", "tags": ["Orgs Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/gateway-templates/create-org-gateway-template"}}, "paths": {"{gatewaytemplate_id}": {"specs": {"delete": {"description": "Delete Organization Gateway Template", "operationId": "deleteOrgGatewayTemplate", "tags": ["Orgs Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/gateway-templates/delete-org-gateway-template"}, "get": {"description": "Get Organization Gateway Template details", "operationId": "getOrgGatewayTemplate", "tags": ["Orgs Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/gateway-templates/get-org-gateway-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/gatewaytemplate_id"}], "put": {"description": "Update Organization Gateway Template", "operationId": "updateOrgGatewayTemplate", "tags": ["Orgs Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/gateway-templates/update-org-gateway-template"}}}}}, "guests": {"specs": {"get": {"description": "Get List of Org Guest Authorizations", "operationId": "listOrgGuestAuthorizations", "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/list-org-guest-authorizations"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count Org Authorized Guest", "operationId": "countOrgGuestAuthorizations", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_guests_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/count-org-guest-authorizations"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Authorized Guest", "operationId": "searchOrgGuestAuthorization", "parameters": [{"description": "WLAN ID", "example": "00000000-0000-0000-0000-000000000000", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"description": "Authentication Methdo", "in": "query", "name": "auth_method", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/search-org-guest-authorization"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{guest_mac}": {"specs": {"delete": {"description": "Delete Guest Authorization", "operationId": "deleteOrgGuestAuthorization", "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/delete-org-guest-authorization"}, "get": {"description": "Get Guest Authorization", "operationId": "getOrgGuestAuthorization", "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/get-org-guest-authorization"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/guest_mac"}], "put": {"description": "Update Guest Authorization", "operationId": "updateOrgGuestAuthorization", "tags": ["Orgs Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/guests/update-org-guest-authorization"}}}}}, "idpprofiles": {"specs": {"get": {"description": "get the list of Org IDP Profiles", "operationId": "listOrgIdpProfiles", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs IDP Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/idp-profiles/list-org-idp-profiles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org IDP Profile", "operationId": "createOrgIdpProfile", "tags": ["Orgs IDP Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/idp-profiles/create-org-idp-profile"}}, "paths": {"{idpprofile_id}": {"specs": {"delete": {"description": "Delete Org IDP Profile", "operationId": "deleteOrgIdpProfile", "tags": ["Orgs IDP Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/idp-profiles/delete-org-idp-profile"}, "get": {"description": "Get Org IDP Profile", "operationId": "getOrgIdpProfile", "tags": ["Orgs IDP Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/idp-profiles/get-org-idp-profile"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/idpprofile_id"}], "put": {"description": "Update Org IDP Profile", "operationId": "updateOrgIdpProfile", "tags": ["Orgs IDP Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/idp-profiles/update-org-idp-profile"}}}}}, "insights": {"paths": {"sites-sle": {"specs": {"get": {"description": "Get Org Sites SLE", "operationId": "getOrgSitesSle", "parameters": [{"in": "query", "name": "sle", "schema": {"$ref": "#/components/schemas/org_site_sle_type"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sles/get-org-sites-sle"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{metric}": {"specs": {"get": {"description": "Get Org SLEs (all/worst sites, Mx Edges, ...)", "operationId": "getOrgSle", "parameters": [{"description": "see [listInsightMetrics](/#operations/listInsightMetrics) for more details", "in": "query", "name": "sle", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}], "tags": ["Orgs SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sles/get-org-sle"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/metric"}]}}}}, "inventory": {"specs": {"get": {"description": "Get Org Inventory\n\n### VC (Virtual-Chassis) Management\nIdeally VC should be managed as a single device - where - one managed entity where config / monitoring is anchored against (with a stable identify MAC) - all members appears in the inventory\n\nIn our implementation, we strive to achieve that without manual user configurations by \n1. during claim or adoption a VC, we require FPC0 to exist and will use its MAC as identify for the entire chassis\n2. other VC members will be automatically populated when they\u2019re all present\n\nThe perceivable result is \n1. from `/sites/:site_id/stats/devices/:fpc0_mac` API, you\u2019d see the VC where module_stat contains the VC members \n2. from `/orgs/:org_id/inventory?vc=true` API, you\u2019d see all VC members with vc_mac pointing to the FPC0", "operationId": "getOrgInventory", "parameters": [{"description": "device serial", "in": "query", "name": "serial", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "site id if assigned, null if not assigned", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "Virtual Chassis MAC Address", "in": "query", "name": "vc_mac", "schema": {"type": "string"}}, {"description": "To display Virtual Chassis members", "in": "query", "name": "vc", "schema": {"default": false, "type": "boolean"}}, {"description": "to display Unassigned devices", "in": "query", "name": "unassigned", "schema": {"default": true, "type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/get-org-inventory"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Add Device to Org Inventory with the device claim codes", "operationId": "addOrgInventory", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/add-org-inventory"}, "put": {"description": "Update Org Inventory", "operationId": "updateOrgInventoryAssignment", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/update-org-inventory-assignment"}}, "paths": {"count": {"specs": {"get": {"description": "Count in the Org Inventory", "operationId": "countOrgInventory", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/inventory_count_distinct"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/count-org-inventory"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "create_ha_cluster": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create HA Cluster from unassigned Gateways", "operationId": "createOrgGatewayHaCluster", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/create-org-gateway-ha-cluster"}}}, "delete_ha_cluster": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Delete HA Cluster\n\nAfter HA cluster deleted, both of the nodes will be unassigned.", "operationId": "deleteOrgGatewayHaCluster", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/delete-org-gateway-ha-cluster"}}}, "reevaluate_auto_assignment": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Reevaluate Auto Assignment", "operationId": "reevaluateOrgAutoAssignment", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/reevaluate-org-auto-assignment"}}}, "replace": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "It\u2019s a common request we get from the customers. When a AP HW has problem and need a replacement, they would want to copy the existing attributes (Device Config) of this old AP to the new one. It can be done by providing the MAC of a device that\u2019s currently in the inventory but not assigned. The Device replaced will become unassigned.\n\nThis API also supports replacement of Mist Edges. This API copies device agnostic attributes from old Mist edge to new one.\nMist manufactured Mist Edges will be reset to factory settings but will still be in Inventory.Brownfield or VM\u2019s will be\ndeleted from Inventory\n\n**Note:** For Gateway devices only like-for-like replacements (can only replace a SRX320 with a SRX320 and not some otehr model) are allowed.", "operationId": "replaceOrgDevices", "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/replace-org-devices"}}}, "search": {"specs": {"get": {"description": "Search in the Org Inventory", "operationId": "searchOrgInventory", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Virtual Chassis MAC Address", "in": "query", "name": "vc_mac", "schema": {"type": "string"}}, {"description": "master device mac for virtual mac cluster", "in": "query", "name": "master_mac", "schema": {"type": "string"}}, {"description": "site id if assigned, null if not assigned", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "device serial", "in": "query", "name": "serial", "schema": {"type": "string"}}, {"description": "true / false", "in": "query", "name": "master", "schema": {"type": "string"}}, {"description": "device sku", "in": "query", "name": "sku", "schema": {"type": "string"}}, {"description": "device version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"description": "device status", "in": "query", "name": "status", "schema": {"type": "string"}}, {"description": "wildcards for name, mac, serial", "in": "query", "name": "text", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Inventory"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/inventory/search-org-inventory"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "invites": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "If the request is successful, an email will also be sent to the user with a link to ```https://manage.mist.com/verify/invite?token=:token&expire=1459632743&org=OrgName```", "operationId": "inviteOrgAdmin", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/invite-org-admin"}}, "paths": {"{invite_id}": {"specs": {"delete": {"description": "Delete Admin Invite", "operationId": "uninviteOrgAdmin", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/uninvite-org-admin"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/invite_id"}], "put": {"description": "Update Admin Invite", "operationId": "updateOrgAdminInvite", "tags": ["Orgs Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/admins/update-org-admin-invite"}}}}}, "jsi": {"paths": {"devices": {"specs": {"get": {"description": "Get List of Org devices that connected to JSI", "operationId": "listOrgJsiDevices", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}, {"description": "Device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "Device serial", "in": "query", "name": "serial", "schema": {"type": "string"}}, {"description": "Device MAC Address", "in": "query", "name": "mac", "schema": {"type": "string"}}], "tags": ["Orgs JSI"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/list-org-jsi-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"outbound_ssh_cmd": {"specs": {"get": {"description": "Adopt JSI devices", "operationId": "adoptOrgJsiDevice", "tags": ["Orgs JSI"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/adopt-org-jsi-device"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{device_mac}": {"paths": {"shell": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Create Shell Session", "operationId": "createOrgJsiDeviceShellSession", "tags": ["Orgs JSI"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/create-org-jsi-device-shell-session"}}}, "upgrade": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Upgrade", "operationId": "upgradeOrgJsiDevice", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-org-jsi-device"}}}}}}}, "inventory": {"specs": {"get": {"description": "Get List of all devices purchased from the accounts associated with the Org", "operationId": "listOrgJsiPastPurchases", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "serial", "schema": {"type": "string"}}], "tags": ["Orgs JSI"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jsi/list-org-jsi-past-purchases"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "licenses": {"specs": {"get": {"description": "Get the list of licenses", "operationId": "getOrgLicencesSummary", "tags": ["Orgs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/licenses/get-org-licences-summary"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "put": {"description": "Move, Undo Move or Delete Org License to Another Org\nIf the admin has admin privilege against the `org_id` and `dst_org_id`, he can move some of the licenses to another Org. Given that: \n1. the specified license is currently active \n2. there\u2019s enough licenses left in the specified license (by subscription_id) \n3. there will still be enough entitled licenses for the type of license after the amendment", "operationId": "moveOrDeleteOrgLicenseToAnotherOrg", "tags": ["Orgs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/licenses/move-or-delete-org-license-to-another-org"}}, "paths": {"usages": {"specs": {"get": {"description": "Get Licenses Usage by Sites\nThis shows license usage (i.e. needed) based on the features enabled for the site.", "operationId": "getOrgLicencesBySite", "tags": ["Orgs Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/licenses/get-org-licences-by-site"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "logs": {"specs": {"get": {"description": "Get List of change logs for the current Org", "operationId": "listOrgAuditLogs", "parameters": [{"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "admin name or email", "in": "query", "name": "admin_name", "schema": {"type": "string"}}, {"description": "message", "in": "query", "name": "message", "schema": {"type": "string"}}, {"description": "sort order", "in": "query", "name": "sort", "schema": {"$ref": "#/components/schemas/list_org_logs_sort"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Logs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/logs/list-org-audit-logs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Audit Logs", "operationId": "countOrgAuditLogs", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_logs_count_distinct"}}, {"in": "query", "name": "admin_id", "schema": {"type": "string"}}, {"in": "query", "name": "admin_name", "schema": {"type": "string"}}, {"in": "query", "name": "site_id", "schema": {"type": "string"}}, {"in": "query", "name": "message", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Logs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/logs/count-org-audit-logs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "maps": {"paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches\n\n### CSV File Format\n```csv\nVendor AP name,Mist AP Mac\nUS Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002\n```", "operationId": "importOrgMaps", "tags": ["Orgs Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/maps/import-org-maps"}}}}}, "marvisinvites": {"specs": {"get": {"description": "List Org Marvis Client Invites", "operationId": "listOrgMarvisClientInvites", "tags": ["Orgs Clients - Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/marvis/list-org-marvis-client-invites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Marvis Client Invites", "operationId": "createOrgMarvisClientInvites", "tags": ["Orgs Clients - Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/marvis/create-org-marvis-client-invites"}}, "paths": {"{marvisinvite_id}": {"specs": {"delete": {"description": "Delete Org Marvis Client Invite", "operationId": "deleteOrgMarvisClientInvite", "tags": ["Orgs Clients - Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/marvis/delete-org-marvis-client-invite"}, "get": {"description": "Get Org Marvis Client Invite", "operationId": "getOrgMarvisClientInvites", "tags": ["Orgs Clients - Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/marvis/get-org-marvis-client-invites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/marvisinvite_id"}], "put": {"description": "Update Org Marvis Client Invite", "operationId": "updateOrgMarvisClientInvite", "tags": ["Orgs Clients - Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/marvis/update-org-marvis-client-invite"}}}}}, "mist_nac": {"paths": {"test_idp": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "IDP Credential Validation. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n``` json\n{\n    \"subscribe\": \"orgs/:org_id/mist_nac/test_idp\"\n}\n\n ```\n\n### Response (no idp can be found)\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/:org_id/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"failure\",\n        \"error\": \"No matching IDP found\"\n    }\n}\n\n ```\n\n### Response OK\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/:org_id/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"success\",\n        \"idp_id\": \"915793c0-1355-4e98-b1c0-23df2227b357\",\n        \"idp_type\": \"ldap\",\n        // more attributes will be added later\n    }\n}\n\n ```\n\n### Response Invalid Credentials\n\n``` json\n{\n    \"event\": \"data\",\n    \"channel\": \"/orgs/:org_id/mist_nac/test_idp\",\n    \"status\": \n    \"data\": {\n        \"status\": \"failure\",\n        \"error\": \"Invalid Credentials\",\n        \"idp_id\": \"915793c0-1355-4e98-b1c0-23df2227b357\",\n        \"idp_type\": \"ldap\",\n    }\n}\n\n ```", "operationId": "validateOrgIdpCredential", "tags": ["Orgs NAC IDP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-idp/validate-org-idp-credential"}}}}}, "mxclusters": {"specs": {"get": {"description": "Get List of Org MxEdge Clusters", "operationId": "listOrgMxEdgeClusters", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs MxClusters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxclusters/list-org-mx-edge-clusters"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create MxCluster", "operationId": "createOrgMxEdgeCluster", "tags": ["Orgs MxClusters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxclusters/create-org-mx-edge-cluster"}}, "paths": {"{mxcluster_id}": {"specs": {"delete": {"description": "Delete Org MXEdge Cluster", "operationId": "deleteOrgMxEdgeCluster", "tags": ["Orgs MxClusters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxclusters/delete-org-mx-edge-cluster"}, "get": {"description": "Get Org MxEdge Cluster Details", "operationId": "getOrgMxEdgeCluster", "tags": ["Orgs MxClusters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxclusters/get-org-mx-edge-cluster"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxcluster_id"}], "put": {"description": "Update Org MxEdge Cluster", "operationId": "updateOrgMxEdgeCluster", "tags": ["Orgs MxClusters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxclusters/update-org-mx-edge-cluster"}}}}}, "mxedges": {"specs": {"get": {"description": "Get List of Org MxEdges", "operationId": "listOrgMxEdges", "parameters": [{"description": "filter for site level mist edges", "in": "query", "name": "for_sites", "schema": {"$ref": "#/components/schemas/mxedge_for_site"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/list-org-mx-edges"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create MxEdge", "operationId": "createOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/create-org-mx-edge"}}, "paths": {"assign": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Assign Org MxEdge to Site", "operationId": "assignOrgMxEdgeToSite", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/assign-org-mx-edge-to-site"}}}, "claim": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "For a Mist Edge in default state, it will show a random claim code like `135-546-673` which you can \u201cclaim\u201d it into your Org", "operationId": "claimOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/claim-org-mx-edge"}}}, "count": {"specs": {"get": {"description": "Count Org Mist Edges", "operationId": "countOrgMxEdges", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_mxedge_count_distinct"}}, {"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"description": "model name", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "debian code name(buster, bullseye)", "in": "query", "name": "distro", "schema": {"type": "string"}}, {"description": "tunterm version", "in": "query", "name": "tunterm_version", "schema": {"type": "string"}}, {"description": "sort options, -prefix represents DESC order, default is -last_seen", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "whether to return device stats, default is false", "in": "query", "name": "stats", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/count-org-mx-edges"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count Org Mist Edge Events", "operationId": "countOrgSiteMxEdgeEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_mxedge_events_count_distinct"}}, {"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/mxedge_event_type"}, {"description": "service running on mist edge(mxagent, tunterm etc)", "in": "query", "name": "service", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/count-org-site-mx-edge-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Mist Edge Events", "operationId": "searchOrgMistEdgeEvents", "parameters": [{"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/mxedge_event_type"}, {"description": "service running on mist edge(mxagent, tunterm etc)", "in": "query", "name": "service", "schema": {"type": "string"}}, {"description": "component like PS1, PS2", "in": "query", "name": "component", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/search-org-mist-edge-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Org Mist Edges", "operationId": "searchOrgMxEdges", "parameters": [{"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"description": "model name", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "debian code name(buster, bullseye)", "in": "query", "name": "distro", "schema": {"type": "string"}}, {"description": "tunterm version", "in": "query", "name": "tunterm_version", "schema": {"type": "string"}}, {"description": "sort options, -prefix represents DESC order, default is -last_seen", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "whether to return device stats, default is false", "in": "query", "name": "stats", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/search-org-mx-edges"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "unassign": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Unassign Org MxEdge from Site", "operationId": "unassignOrgMxEdgeFromSite", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/unassign-org-mx-edge-from-site"}}}, "upgrade": {"specs": {"get": {"description": "Get List of Org Mist Edge Upgrades", "operationId": "listOrgMxEdgeUpgrades", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-org-mx-edge-upgrades"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Upgrade Mist Edges", "operationId": "upgradeOrgMxEdges", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-org-mx-edges"}}, "paths": {"{upgrade_id}": {"specs": {"get": {"description": "Get Mist Edge Upgrade", "operationId": "getOrgMxEdgeUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/get-org-mx-edge-upgrade"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/upgrade_id"}]}}}}, "version": {"specs": {"get": {"description": "Get Mist Edge Upgrade Information", "operationId": "getOrgMxEdgeUpgradeInfo", "parameters": [{"description": "upgrade channel to follow, stable (default) / beta / alpha", "in": "query", "name": "channel", "schema": {"$ref": "#/components/schemas/get_org_mxedge_upgrade_info_channel"}}], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/get-org-mx-edge-upgrade-info"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{mxedge_id}": {"specs": {"delete": {"description": "Delete Org MxEdge", "operationId": "deleteOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/delete-org-mx-edge"}, "get": {"description": "Get Org MxEdge details", "operationId": "getOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/get-org-mx-edge"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "put": {"description": "Update Org MxEdge", "operationId": "updateOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/update-org-mx-edge"}}, "paths": {"image": {"paths": {"{image_number}": {"specs": {"delete": {"description": "Remove MxEdge Image", "operationId": "deleteOrgMxEdgeImage", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/delete-org-mx-edge-image"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}, {"in": "path", "name": "image_number", "required": true, "schema": {"maximum": 3, "minimum": 1, "type": "integer"}}], "post": {"description": "Attach up to 3 images to a mxedge", "operationId": "addOrgMxEdgeImage", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/add-org-mx-edge-image"}}}}}, "restart": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "post": {"description": "In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register.", "operationId": "restartOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/restart-org-mx-edge"}}}, "services": {"paths": {"tunterm": {"paths": {"bounce_port": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "post": {"description": "Bounce TunTerm Data Ports", "operationId": "bounceOrgMxEdgeDataPorts", "parameters": [], "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/bounce-org-mx-edge-data-ports"}}}}}, "{name}": {"paths": {"{action}": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}, {"description": "enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`", "in": "path", "name": "name", "required": true, "schema": {"$ref": "#/components/schemas/mxedge_service_name"}}, {"description": "restart or start or stop", "in": "path", "name": "action", "required": true, "schema": {"$ref": "#/components/schemas/mxedge_service_action"}}], "post": {"description": "Control Services on a Mist Edge", "operationId": "controlOrgMxEdgeServices", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/control-org-mx-edge-services"}}}}}}}, "support": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "post": {"description": "Support / Upload Mist Edge support files", "operationId": "uploadOrgMxEdgeSupportFiles", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/upload-org-mx-edge-support-files"}}}, "unregister": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "post": {"description": "In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register.", "operationId": "unregisterOrgMxEdge", "tags": ["Orgs MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxedges/unregister-org-mx-edge"}}}}}}}, "mxtunnels": {"specs": {"get": {"description": "Get List of Org MxTunnels", "operationId": "listOrgMxTunnels", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs MxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxtunnels/list-org-mx-tunnels"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create MxTunnel", "operationId": "createOrgMxTunnel", "tags": ["Orgs MxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxtunnels/create-org-mx-tunnel"}}, "paths": {"{mxtunnel_id}": {"specs": {"delete": {"description": "Delete Org MxTunnel", "operationId": "deleteOrgMxTunnel", "tags": ["Orgs MxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxtunnels/delete-org-mx-tunnel"}, "get": {"description": "Get Org MxTunnel Details", "operationId": "getOrgMxTunnel", "tags": ["Orgs MxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxtunnels/get-org-mx-tunnel"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxtunnel_id"}], "put": {"description": "Update Org MxTunnel", "operationId": "updateOrgMxTunnel", "tags": ["Orgs MxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/mxtunnels/update-org-mx-tunnel"}}}}}, "nac_clients": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of NAC Clients", "operationId": "countOrgNacClients", "parameters": [{"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_nac_clients_count_distinct"}}, {"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "last_nacrule_id", "schema": {"type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan ID", "in": "query", "name": "last_vlan_id", "schema": {"type": "string"}}, {"description": "vendor of NAS device", "in": "query", "name": "last_nas_vendor", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "last_ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "last_username", "schema": {"type": "string"}}, {"description": "start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "site id if assigned, null if not assigned", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "AP MAC connected to by client", "in": "query", "name": "last_ap", "schema": {"type": "string"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Connection status of client i.e \u201cpermitted\u201d, \u201cdenied, \u201csession_ended\u201d", "in": "query", "name": "last_status", "schema": {"type": "string"}}, {"description": "Client type i.e. \u201cwireless\u201d, \u201cwired\u201d etc.", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "MDM compliancy of client i.e \u201ccompliant\u201d, \u201cnot compliant\u201d", "in": "query", "name": "mdm_compliance_status", "schema": {"type": "string"}}, {"description": "MDM provider of client\u2019s organisation eg \u201cintune\u201d, \u201cjamf\u201d", "in": "query", "name": "mdm_provider", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/nac/count-org-nac-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of NAC Client-Events", "operationId": "countOrgNacClientEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_nac_client_events_count_distinct"}}, {"$ref": "#/components/parameters/nac_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/nac/count-org-nac-client-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search NAC Client Events", "operationId": "searchOrgNacClientEvents", "parameters": [{"$ref": "#/components/parameters/nac_event_type"}, {"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "nacrule_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "NAC Policy Dry Run Rule ID, if present and matched", "in": "query", "name": "dryrun_nacrule_id", "schema": {"type": "string"}}, {"description": "True - if dryrun rule present and matched with priority, False - if not matched or not present", "in": "query", "name": "dryrun_nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan name or ID assigned to the client", "in": "query", "name": "vlan", "schema": {"type": "integer"}}, {"description": "vendor of NAS device", "in": "query", "name": "nas_vendor", "schema": {"type": "string"}}, {"description": "BSSID", "in": "query", "name": "bssid", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "IDP returned roles/groups for the user", "in": "query", "name": "idp_role", "schema": {"type": "string"}}, {"description": "Username presented to the Identity Provider", "in": "query", "name": "idp_username", "schema": {"type": "string"}}, {"description": "Radius attributes returned by NAC to NAS Devive", "in": "query", "name": "resp_attrs", "schema": {"$ref": "#/components/schemas/strings"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "username", "schema": {"type": "string"}}, {"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "AP random macMAC", "in": "query", "name": "random_mac", "schema": {"type": "boolean"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "labels derived from usermac entry", "in": "query", "name": "usermac_label", "schema": {"type": "string"}}, {"description": "partial / full MAC address, username, device_mac or ap", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "IP address of NAS device", "in": "query", "name": "nas_ip", "schema": {"type": "string"}}, {"description": "sort options, \u2018-\u2018 prefix represents DESC order, default is wcid in ASC order", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "vendor specific Vlan ID in radius requests", "in": "query", "name": "ingress_vlan", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/nac/search-org-nac-client-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Org NAC Clients", "operationId": "searchOrgNacClients", "parameters": [{"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan name or ID assigned to the client", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"description": "vendor of NAS device", "in": "query", "name": "nas_vendor", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "username", "schema": {"type": "string"}}, {"description": "start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "site id if assigned, null if not assigned", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "AP MAC connected to by client", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Connection status of client i.e \u201cpermitted\u201d, \u201cdenied, \u201csession_ended\u201d", "in": "query", "name": "status", "schema": {"type": "string"}}, {"description": "Client type i.e. \u201cwireless\u201d, \u201cwired\u201d etc.", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "MDM compliancy of client i.e \u201ccompliant\u201d, \u201cnot compliant\u201d", "in": "query", "name": "mdm_compliance", "schema": {"type": "string"}}, {"description": "MDM provider of client\u2019s organisation eg \u201cintune\u201d, \u201cjamf\u201d", "in": "query", "name": "mdm_provider", "schema": {"type": "string"}}, {"description": "sort options, \u2018-\u2018 prefix represents DESC order, default is wcid in ASC order", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "vendor specific Vlan ID in radius requests", "in": "query", "name": "ingress_vlan", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/nac/search-org-nac-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "nacportals": {"specs": {"get": {"description": "List Org NAC Portals", "operationId": "listOrgNacPortals", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/list-org-nac-portals"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org NAC Portal", "operationId": "createOrgNacPortal", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/create-org-nac-portal"}}, "paths": {"{nacportal_id}": {"specs": {"delete": {"description": "Delete Org NAC Portal", "operationId": "deleteOrgNacPortal", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/delete-org-nac-portal"}, "get": {"description": "Get Org NAC Portal", "operationId": "getOrgNacPortal", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/get-org-nac-portal"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}], "put": {"description": "Update Org NAC Portal", "operationId": "updateOrgNacPortal", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/update-org-nac-portal"}}, "paths": {"failures": {"specs": {"get": {"description": "Get List of Org NAC Portal SSO Latest Failures", "operationId": "listOrgNacPortalSsoLatestFailures", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/list-org-nac-portal-sso-latest-failures"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}]}}, "portal_image": {"specs": {"delete": {"description": "Delete background image for NAC Portal\n\n\nIf image is not uploaded or is deleted, NAC Portal will use default image.", "operationId": "deleteOrgNacPortalImage", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/delete-org-nac-portal-image"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}], "post": {"description": "Upload background image for NAC Portal", "operationId": "uploadOrgNacPortalImage", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/upload-org-nac-portal-image"}}}, "portal_template": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}], "put": {"description": "Update Org NAC Portal Template", "operationId": "updateOrgNacPortalTempalte", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/update-org-nac-portal-tempalte"}}}, "saml_metadata": {"specs": {"get": {"description": "Get Org NAC Portal SAML Metadata", "operationId": "getOrgNacPortalSamlMetadata", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/get-org-nac-portal-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}]}}, "saml_metadata.xml": {"specs": {"get": {"description": "Download Org NAC Portal SAML Metdata\n\nExample of metadata.xml:\n```xml\n<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" validUntil=\"2027-10-12T21:59:01Z\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">\n    <md:SPSSODescriptor AuthnRequestsSigned=\"false\" WantAssertionsSigned=\"true\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">\n        <md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/logout\" />\n        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>\n        <md:AssertionConsumerService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" index=\"0\" isDefault=\"true\"/>\n        <md:AttributeConsumingService index=\"0\">\n            <md:ServiceName xml:lang=\"en-US\">Mist</md:ServiceName>\n            <md:RequestedAttribute Name=\"Role\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"true\"/>\n            <md:RequestedAttribute Name=\"FirstName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n            <md:RequestedAttribute Name=\"LastName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n        </md:AttributeConsumingService>\n    </md:SPSSODescriptor>\n</md:EntityDescriptor>\n```", "operationId": "downloadOrgNacPortalSamlMetadata", "tags": ["Orgs NAC Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-portals/download-org-nac-portal-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacportal_id"}]}}}}}}, "nacrules": {"specs": {"get": {"description": "Get List of Org NAC Rules", "operationId": "listOrgNacRules", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs NAC Rules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-rules/list-org-nac-rules"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "create Org NAC Rule", "operationId": "createOrgNacRule", "tags": ["Orgs NAC Rules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-rules/create-org-nac-rule"}}, "paths": {"{nacrule_id}": {"specs": {"delete": {"description": "Delete Org NAC Rule", "operationId": "deleteOrgNacRule", "tags": ["Orgs NAC Rules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-rules/delete-org-nac-rule"}, "get": {"description": "Get Org NAC Rule", "operationId": "getOrgNacRule", "tags": ["Orgs NAC Rules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-rules/get-org-nac-rule"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nacrule_id"}], "put": {"description": "Update Org NAC Rule", "operationId": "updateOrgNacRule", "tags": ["Orgs NAC Rules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-rules/update-org-nac-rule"}}}}}, "nactags": {"specs": {"get": {"description": "Get List of Org NAC Tags", "operationId": "listOrgNacTags", "parameters": [{"description": "Type of NAC Tag", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "Name of NAC Tag", "in": "query", "name": "name", "schema": {"type": "string"}}, {"description": "Type of NAC Tag", "in": "query", "name": "match", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs NAC Tags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-tags/list-org-nac-tags"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org NAC Tag", "operationId": "createOrgNacTag", "tags": ["Orgs NAC Tags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-tags/create-org-nac-tag"}}, "paths": {"{nactag_id}": {"specs": {"delete": {"description": "Delete Org NAC Tag", "operationId": "deleteOrgNacTag", "tags": ["Orgs NAC Tags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-tags/delete-org-nac-tag"}, "get": {"description": "Get Org NAC Tag", "operationId": "getOrgNacTag", "tags": ["Orgs NAC Tags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-tags/get-org-nac-tag"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/nactag_id"}], "put": {"description": "Update Org NAC Tag", "operationId": "updateOrgNacTag", "tags": ["Orgs NAC Tags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-tags/update-org-nac-tag"}}}}}, "networks": {"specs": {"get": {"description": "Get List of Org Networks", "operationId": "listOrgNetworks", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/networks/list-org-networks"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Organization Network", "operationId": "createOrgNetwork", "tags": ["Orgs Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/networks/create-org-network"}}, "paths": {"{network_id}": {"specs": {"delete": {"description": "Delete Organization Network", "operationId": "deleteOrgNetwork", "tags": ["Orgs Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/networks/delete-org-network"}, "get": {"description": "Get Organization Network Details", "operationId": "getOrgNetwork", "tags": ["Orgs Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/networks/get-org-network"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/network_id"}], "put": {"description": "Update Organization Network", "operationId": "updateOrgNetwork", "tags": ["Orgs Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/networks/update-org-network"}}}}}, "networktemplates": {"specs": {"get": {"description": "Get List of Org Network Templates", "operationId": "listOrgNetworkTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/network-templates/list-org-network-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Update Org Network Templates", "operationId": "createOrgNetworkTemplate", "tags": ["Orgs Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/network-templates/create-org-network-template"}}, "paths": {"{networktemplate_id}": {"specs": {"delete": {"description": "Delete Org Network Template", "operationId": "deleteOrgNetworkTemplate", "tags": ["Orgs Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/network-templates/delete-org-network-template"}, "get": {"description": "Get Org Network Templates Details", "operationId": "getOrgNetworkTemplate", "tags": ["Orgs Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/network-templates/get-org-network-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/networktemplate_id"}], "put": {"description": "Update Org Network Template", "operationId": "updateOrgNetworkTemplates", "parameters": [], "tags": ["Orgs Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/network-templates/update-org-network-templates"}}}}}, "ocdevices": {"paths": {"outbound_ssh_cmd": {"specs": {"get": {"description": "Get Org Juniper Devices command\n\nJuniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used.\nA few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist.", "operationId": "getOrgJuniperDevicesCommand", "parameters": [{"description": "site_id would be used for proxy config check of the site and automatic site assignment", "in": "query", "name": "site_id", "schema": {"type": "string"}}], "tags": ["Orgs Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/get-org-juniper-devices-command"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "otherdevices": {"specs": {"get": {"description": "Get List of Org other devices (3rd party devices)", "operationId": "listOrgOtherDevices", "parameters": [{"in": "query", "name": "vendor", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "serial", "schema": {"type": "string"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "name", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/list-org-other-devices"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "put": {"description": "Assign or unassign OtherDevices to and from a site.", "operationId": "updateOrgOtherDevices", "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/update-org-other-devices"}}, "paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Org OtherDevices Events", "operationId": "countOrgOtherDeviceEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_otherdevices_events_count_distinct"}}, {"$ref": "#/components/parameters/otherdevice_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/count-org-other-device-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org OtherDevices Events", "operationId": "searchOrgOtherDeviceEvents", "parameters": [{"description": "site id", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "mac of attached device", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "vendor name", "in": "query", "name": "vendor", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/otherdevice_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/search-org-other-device-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "{device_mac}": {"specs": {"delete": {"description": "Delete OtherDevice", "operationId": "deleteOrgOtherDevice", "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/delete-org-other-device"}, "get": {"description": "Get Org other device (3rd party device)", "operationId": "getOrgOtherDevice", "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/get-org-other-device"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "put": {"description": "If the Site / Device cannot be identified, a manual association can be made", "operationId": "updateOrgOtherDevice", "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/update-org-other-device"}}, "paths": {"reboot": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}], "post": {"description": "Reboot OtherDevice", "operationId": "rebootOrgOtherDevice", "tags": ["Orgs Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/devices/others/reboot-org-other-device"}}}}}}}, "pcaps": {"specs": {"get": {"description": "Get List of Org  Packet Captures", "operationId": "listOrgPacketCaptures", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/list-org-packet-captures"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"capture": {"specs": {"delete": {"description": "Stop current Org capture", "operationId": "stopOrgPacketCapture", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/stop-org-packet-capture"}, "get": {"description": "Get Org Capturing status", "operationId": "getOrgCapturingStatus", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/get-org-capturing-status"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Initiate a Packet Capture\n\n**NOTE**: For packet captures of org level Mist Edges only. Use [Start Site Packet Capture](/#operations/startSitePacketCapture) for site level Mist Edges. \n\nThe output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/pcaps\"\n}\n```\n#### Response (Wireless/RadioTap)\n```json\n{\n  \"event\": \"data\"\n  \"channel\": \"/orgs/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n  \"data\": {\n      \"capture_id\": \"f039b1b4-a23e-48b2-906a-0da40524de73\", \n      \"pcap_dict\": {\n          \"dst_mac\": \"68:ec:c5:09:2e:87\",\n          \"src_mac\": \"8c:3b:ad:e0:47:40\", \n          \"vlan\": 1, \n          \"src_ip\": \"34.224.147.117\", \n          \"dst_ip\": \"192.168.1.55\",\n          \"dst_port\": 51635, \n          \"src_port\": 443,\n          \"protocol\": \"TCP\", \n          \"mxedge_id\": \"00000000-0000-0000-1000-001122334455\",\n          \"direction\": \"tx\", \n          \"timestamp\": 1652247615, \n          \"length\": 159.0, \n          \"interface\": \"port0\",\n          \"info\": \"1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq \n                    2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\\\n\",\n          }, \n      \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==\\\"\n    }\n}\n```", "operationId": "startOrgPacketCapture", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/start-org-packet-capture"}}}}}, "pma": {"paths": {"dashboards": {"specs": {"get": {"description": "Get List of premium analytics dashboards for this Org", "operationId": "listOrgPmaDashboards", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Premium Analytics"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/premium-analytics/list-org-pma-dashboards"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "pskportals": {"specs": {"get": {"description": "Get List of Org Psk Portals", "operationId": "listOrgPskPortals", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/list-org-psk-portals"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Psk Portal", "operationId": "createOrgPskPortal", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/create-org-psk-portal"}}, "paths": {"logs": {"specs": {"get": {"description": "Get the list of PSK Portals Logs", "operationId": "listOrgPskPortalLogs", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/list-org-psk-portal-logs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of PskPortal Logs", "operationId": "countOrgPskPortalLogs", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_psk_portal_logs_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/count-org-psk-portal-logs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org PSK Portal Logs", "operationId": "searchOrgPskPortalLogs", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}, {"in": "query", "name": "psk_name", "schema": {"type": "string"}}, {"in": "query", "name": "psk_id", "schema": {"type": "string"}}, {"in": "query", "name": "pskportal_id", "schema": {"type": "string"}}, {"description": "audit_id", "in": "query", "name": "id", "schema": {"format": "uuid", "type": "string"}}, {"in": "query", "name": "admin_name", "schema": {"type": "string"}}, {"in": "query", "name": "admin_id", "schema": {"type": "string"}}, {"description": "name_id used in SSO", "in": "query", "name": "name_id", "schema": {"format": "uuid", "type": "string"}}], "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/search-org-psk-portal-logs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "{pskportal_id}": {"specs": {"delete": {"description": "Delete Org Psk Portal", "operationId": "deleteOrgPskPortal", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/delete-org-psk-portal"}, "get": {"description": "get Org Psk Portal Details", "operationId": "getOrgPskPortal", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/get-org-psk-portal"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/pskportal_id"}], "put": {"description": "update Org Psk Portal", "operationId": "updateOrgPskPortal", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/update-org-psk-portal"}}, "paths": {"portal_image": {"specs": {"delete": {"description": "Delete background image for PskPortal\n\n\nIf image is not uploaded or is deleted, PskPortal will use default image.", "operationId": "deleteOrgPskPortalImage", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/delete-org-psk-portal-image"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/pskportal_id"}], "post": {"description": "Upload background image for PskPortal", "operationId": "uploadOrgPskPortalImage", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/upload-org-psk-portal-image"}}}, "portal_template": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/pskportal_id"}], "put": {"description": "Update Org Psk Portal Template", "operationId": "updateOrgPskPortalTemplate", "tags": ["Orgs Psk Portals"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psk-portals/update-org-psk-portal-template"}}}}}}}, "psks": {"specs": {"get": {"description": "Get List of Org Psks", "operationId": "listOrgPsks", "parameters": [{"example": "psk_name", "in": "query", "name": "name", "schema": {"type": "string"}}, {"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"in": "query", "name": "role", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/list-org-psks"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org PSK\n\n\nWhen `usage`==`macs`, corresponding \"macs\" field will hold a list consisting of client mac addresses ([\"xx:xx:xx:xx:xx\",...]) or mac patterns([\"xx:xx:*\",\"xx*\",...]) or both ([\"xx:xx:xx:xx:xx:xx\", \"xx:*\", ...]). This list is capped at 5000", "operationId": "createOrgPsk", "parameters": [{"description": "if a key exists with the same `name`, replace it with the new one", "in": "query", "name": "upsert", "schema": {"type": "boolean"}}], "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/create-org-psk"}, "put": {"description": "Update Multiple PSKs", "operationId": "updateOrgMultiplePsks", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/update-org-multiple-psks"}}, "paths": {"delete": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Delete Org PSK List\n\nDelete list of psks on the org. This API accepts single string or list of strings", "operationId": "deleteOrgPskList", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/delete-org-psk-list"}}}, "import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Import PSK from CSV file or JSON\n\n##\u00a0CSV File Format\n```\nPSK Import CSV File Format:\nname,ssid,passphrase,usage,vlan_id,mac,max_usage,role,expire_time,notify_expiry,expiry_notification_time,notify_on_create_or_edit,email\nCommon,warehouse,foryoureyesonly,single,35,a31425f31278,0,student,1618594236\nJustin,reception,visible,multi,1002,200,teacher,1618594236\nCommon2,ssid,1245678-xx,single,35,a31425f31278,0,student,1618594236,true,7,true,admin@test.com\n```", "operationId": "importOrgPsks", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/import-org-psks"}}}, "{psk_id}": {"specs": {"delete": {"description": "Delete Org PSK", "operationId": "deleteOrgPsk", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/delete-org-psk"}, "get": {"description": "Get Org PSK Details", "operationId": "getOrgPsk", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/get-org-psk"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/psk_id"}], "put": {"description": "Update Org PSK", "operationId": "updateOrgPsk", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/update-org-psk"}}, "paths": {"delete_old_passphrase": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/psk_id"}], "post": {"description": "Delete `old_passphrase` from PSK. \nIf successful, response is same as GET, returns the PSK with `old_passphrase` removed.", "operationId": "deleteOrgPskOldPassphrase", "tags": ["Orgs Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/psks/delete-org-psk-old-passphrase"}}}}}}}, "rftemplates": {"specs": {"get": {"description": "Get List of Org RF Template", "operationId": "listOrgRfTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/rf-templates/list-org-rf-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org RF Template", "operationId": "createOrgRfTemplate", "tags": ["Orgs RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/rf-templates/create-org-rf-template"}}, "paths": {"{rftemplate_id}": {"specs": {"delete": {"description": "Delete Org RF Template", "operationId": "deleteOrgRfTemplate", "tags": ["Orgs RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/rf-templates/delete-org-rf-template"}, "get": {"description": "Get Org RF Template Details", "operationId": "getOrgRfTemplate", "tags": ["Orgs RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/rf-templates/get-org-rf-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/rftemplate_id"}], "put": {"description": "Update Org RF Template", "operationId": "updateOrgRfTemplate", "tags": ["Orgs RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/rf-templates/update-org-rf-template"}}}}}, "sdkclients": {"paths": {"{sdkclient_id}": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdkclient_id"}], "put": {"description": "Update SDK Client", "operationId": "updateSdkClient", "tags": ["Orgs Clients - SDK"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/sdk/update-sdk-client"}}}}}, "sdkinvites": {"specs": {"get": {"description": "Get List of Org SDK Invites", "operationId": "listSdkInvites", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/list-sdk-invites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create SDK Invite", "operationId": "createSdkInvite", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/create-sdk-invite"}}, "paths": {"{sdkinvite_id}": {"specs": {"delete": {"description": "Revoke SDK Invite", "operationId": "revokeSdkInvite", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/revoke-sdk-invite"}, "get": {"description": "Get SDK Invite Details", "operationId": "getSdkInvite", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/get-sdk-invite"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdkinvite_id"}], "put": {"description": "Update SDK Invite", "operationId": "updateSdkInvite", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/update-sdk-invite"}}, "paths": {"email": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdkinvite_id"}], "post": {"description": "Send SDK Invite by Email", "operationId": "sendSdkInviteEmail", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/send-sdk-invite-email"}}}, "qrcode": {"specs": {"get": {"description": "Revoke SDK Invite", "operationId": "getSdkInviteQrCode", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/get-sdk-invite-qr-code"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdkinvite_id"}]}}, "sms": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdkinvite_id"}], "post": {"description": "Send SDK Invite by SMS", "operationId": "sendSdkInviteSms", "tags": ["Orgs SDK Invites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-invites/send-sdk-invite-sms"}}}}}}}, "sdktemplates": {"specs": {"get": {"description": "Get List of Org SDK Templates", "operationId": "listSdkTemplates", "tags": ["Orgs SDK Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-templates/list-sdk-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create SDK Template", "operationId": "createSdkTemplate", "tags": ["Orgs SDK Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-templates/create-sdk-template"}}, "paths": {"{sdktemplate_id}": {"specs": {"delete": {"description": "Delete SDK Template", "operationId": "deleteSdkTemplate", "tags": ["Orgs SDK Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-templates/delete-sdk-template"}, "get": {"description": "Get SDK Template Details", "operationId": "getSdkTemplate", "tags": ["Orgs SDK Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-templates/get-sdk-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sdktemplate_id"}], "put": {"description": "Update SDK Template", "operationId": "updateSdkTemplate", "tags": ["Orgs SDK Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sdk-templates/update-sdk-template"}}}}}, "secintelprofiles": {"specs": {"get": {"description": "Get List of Sec Intel Profiles", "operationId": "listOrgSecIntelProfiles", "tags": ["Orgs SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secintel-profiles/list-org-sec-intel-profiles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Sec Intel Profiles", "operationId": "createOrgSecIntelProfile", "tags": ["Orgs SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secintel-profiles/create-org-sec-intel-profile"}}, "paths": {"{secintelprofile_id}": {"specs": {"delete": {"description": "Delete Sec Intel Profile", "operationId": "deleteOrgSecIntelProfile", "tags": ["Orgs SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secintel-profiles/delete-org-sec-intel-profile"}, "get": {"description": "Get Sec Intel Profile", "operationId": "getOrgSecIntelProfile", "tags": ["Orgs SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secintel-profiles/get-org-sec-intel-profile"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/secintelprofile_id"}], "put": {"description": "Update Sec Intel Profile", "operationId": "updateOrgSecIntelProfile", "tags": ["Orgs SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secintel-profiles/update-org-sec-intel-profile"}}}}}, "secpolicies": {"specs": {"get": {"description": "Get List of Org Security Policies", "operationId": "listOrgSecPolicies", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs SecPolicies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secpolicies/list-org-sec-policies"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Security Policy", "operationId": "createOrgSecPolicies", "tags": ["Orgs SecPolicies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secpolicies/create-org-sec-policies"}}, "paths": {"{secpolicy_id}": {"specs": {"delete": {"description": "Delete Org Security Policy", "operationId": "deleteOrgSecPolicy", "tags": ["Orgs SecPolicies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secpolicies/delete-org-sec-policy"}, "get": {"description": "Get Org Security Policy", "operationId": "getOrgSecPolicy", "tags": ["Orgs SecPolicies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secpolicies/get-org-sec-policy"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/secpolicy_id"}], "put": {"description": "Update Org Security Policy", "operationId": "updateOrgSecPolicies", "tags": ["Orgs SecPolicies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/secpolicies/update-org-sec-policies"}}}}}, "servicepolicies": {"specs": {"get": {"description": "Get List of Org Service Policies", "operationId": "listOrgServicePolicies", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/service-policies/list-org-service-policies"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Serrvice Policy", "operationId": "createOrgServicePolicy", "tags": ["Orgs Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/service-policies/create-org-service-policy"}}, "paths": {"{servicepolicy_id}": {"specs": {"delete": {"description": "Delete Org Service Policuy", "operationId": "deleteOrgServicePolicy", "tags": ["Orgs Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/service-policies/delete-org-service-policy"}, "get": {"description": "Get Org Service Policy Details", "operationId": "getOrgServicePolicy", "tags": ["Orgs Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/service-policies/get-org-service-policy"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/servicepolicy_id"}], "put": {"description": "Update Org Serrvice Policy", "operationId": "updateOrgServicePolicy", "tags": ["Orgs Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/service-policies/update-org-service-policy"}}}}}, "services": {"specs": {"get": {"description": "Get List of Org Services", "operationId": "listOrgServices", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/services/list-org-services"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create getOrgServices Service", "operationId": "createOrgService", "tags": ["Orgs Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/services/create-org-service"}}, "paths": {"{service_id}": {"specs": {"delete": {"description": "delete Org Service", "operationId": "deleteOrgService", "tags": ["Orgs Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/services/delete-org-service"}, "get": {"description": "Get Org Service", "operationId": "getOrgService", "tags": ["Orgs Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/services/get-org-service"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/service_id"}], "put": {"description": "update Org Service", "operationId": "updateOrgService", "tags": ["Orgs Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/services/update-org-service"}}}}}, "setting": {"specs": {"get": {"description": "Get Org Settings", "operationId": "getOrgSettings", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/get-org-settings"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "put": {"description": "Update Org Settings", "operationId": "updateOrgSettings", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/update-org-settings"}}, "paths": {"blacklist": {"specs": {"delete": {"description": "Delete Org Blacklist Station Clients", "operationId": "deleteOrgWirelessClientsBlocklist", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/delete-org-wireless-clients-blocklist"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "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", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/create-org-wireless-clients-blocklist"}}}, "cradlepoint": {"paths": {"setup": {"specs": {"delete": {"description": "This deletes the Cradlepoint integration in Mist", "operationId": "deleteOrgCradlepointConnection", "tags": ["Orgs Cradlepoint"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cradlepoint/delete-org-cradlepoint-connection"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "This sets up cradlepoint webhooks to send events to Mist", "operationId": "setupOrgCradlepointConnectionToMist", "tags": ["Orgs Cradlepoint"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cradlepoint/setup-org-cradlepoint-connection-to-mist"}, "put": {"description": "This updates the Cradlepoint integration settings in Mist", "operationId": "updateOrgCradlepointConnectionToMist", "tags": ["Orgs Cradlepoint"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cradlepoint/update-org-cradlepoint-connection-to-mist"}}}, "sync": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "This syncs cradlepoint devices with Mist. We\u2019ll also attempt to use the LLDP data from cradlepoint to identify the linkage against Mist Site / Device", "operationId": "syncOrgCradlepointRouters", "tags": ["Orgs Cradlepoint"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cradlepoint/sync-org-cradlepoint-routers"}}}}}, "jse": {"paths": {"info": {"specs": {"get": {"description": "Retrieves the list of JSE orgs associated with the account.", "operationId": "getOrgJseInfo", "tags": ["Orgs JSE"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jse/get-org-jse-info"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "setup": {"specs": {"delete": {"description": "Delete JSE credential", "operationId": "deleteOrgJsecCredential", "tags": ["Orgs JSE"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jse/delete-org-jsec-credential"}, "get": {"description": "Get Org JSE Credential", "operationId": "getOrgJsecCredential", "tags": ["Orgs JSE"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jse/get-org-jsec-credential"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "in JSE UI: \n1. Create custom role with Read access to service_location and RW access to site and IPSec profile APIs. \n2. Create a user with the above custom role. - email: john@abc.com \n3. Activate the user in the JSE account. \n4. Create the service locations on the JSE account.", "operationId": "setupOrgJsecCredential", "tags": ["Orgs JSE"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/jse/setup-org-jsec-credential"}}}}}, "juniper": {"paths": {"link_accounts": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Link Juniper Accounts", "operationId": "linkOrgToJuniperJuniperAccount", "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/link-org-to-juniper-juniper-account"}}}, "unlink_account": {"specs": {"delete": {"description": "Unlink Juniper Customer ID\n`linked_by` field is only required if there are duplicate account_names.", "operationId": "unlinkOrgFromJuniperCustomerId", "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/unlink-org-from-juniper-customer-id"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "mist_nac_crls": {"specs": {"get": {"description": "Returns all uploaded CRL file IDs with names for the orgI", "operationId": "getOrgNacCrl", "tags": ["Orgs NAC CRL"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-crl/get-org-nac-crl"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "The Import NAC Org CRL File endpoint allows users to manually upload a Certificate Revocation List (CRL) file in either PEM or DER format. This is a multipart POST request. We support one file upload per issuer, and re-uploads for the same issuer will overwrite the existing file.", "operationId": "importOrgNacCrl", "tags": ["Orgs NAC CRL"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-crl/import-org-nac-crl"}}, "paths": {"{naccrl_id}": {"specs": {"delete": {"description": "Delete NAC Org CRL file is a DELETE request to delete CRL file identified by its ID (ID assigned on file upload/creation)", "operationId": "deleteOrgNacCrl", "tags": ["Orgs NAC CRL"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/nac-crl/delete-org-nac-crl"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/naccrl_id"}]}}}}, "mist_scep": {"specs": {"delete": {"description": "Disable Mist SCEP Org setting", "operationId": "disableOrgMistScep", "tags": ["Orgs SCEP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/scep/disable-org-mist-scep"}, "get": {"description": "Get Mist SCEP Org setting", "operationId": "getOrgMistScep", "tags": ["Orgs SCEP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/scep/get-org-mist-scep"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "put": {"description": "Update Mist SCEP Org setting", "operationId": "updateOrgMistScep", "tags": ["Orgs SCEP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/scep/update-org-mist-scep"}}, "paths": {"client_certs": {"specs": {"get": {"description": "Get Issued Client Certificates", "operationId": "getOrgIssuedClientCertificates", "parameters": [{"description": "sso_name_id obtained from NAC Portal", "in": "query", "name": "sso_name_id", "schema": {"type": "string"}}, {"description": "serial number of the certificate", "in": "query", "name": "serial_number", "schema": {"type": "string"}}, {"description": "Device ID", "in": "query", "name": "device_id", "schema": {"type": "string"}}], "tags": ["Orgs SCEP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/scep/get-org-issued-client-certificates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"revoke": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Revoke Issued Client Certificates", "operationId": "revokeOrgIssuedClientCertificates", "tags": ["Orgs SCEP"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/scep/revoke-org-issued-client-certificates"}}}}}}}, "pcap_bucket": {"paths": {"setup": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Provide Customer Bucket Name\n\nSetting up Custom PCAP Bucket Involves the following:\n* provide the bucket name\n* we\u2019ll attempt to write a file MIST_TOKEN\n* you have to verify the ownership of the bucket by providing the content of the MIST_TOKEN", "operationId": "setOrgCustomBucket", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/set-org-custom-bucket"}}}, "verify": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Verify Customer PCAP Bucket\n\n**Note**: If successful, a \u201cVERIFIED\u201d file will be created in the bucket", "operationId": "verifyOrgCustomBucket", "tags": ["Orgs Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting/verify-org-custom-bucket"}}}}}, "zscaler": {"paths": {"setup": {"specs": {"delete": {"description": "To delete Zscaler credential", "operationId": "deleteOrgZscalerCredential", "tags": ["Orgs Setting Zscaler"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting-zscaler/delete-org-zscaler-credential"}, "get": {"description": "To get Zscaler credential", "operationId": "getOrgZscalerCredential", "tags": ["Orgs Setting Zscaler"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting-zscaler/get-org-zscaler-credential"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "To setup Zscaler credential", "operationId": "setupOrgZscalerCredential", "tags": ["Orgs Setting Zscaler"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/setting-zscaler/setup-org-zscaler-credential"}}}}}, "{app_name}": {"paths": {"link_accounts": {"specs": {"get": {"description": "Get Org Level OAuth Application Linked Status", "operationId": "getOrgOauthAppLinkedStatus", "parameters": [{"description": "Mist portal url to which backend needs to redirect after succesful OAuth authorization. **Required** to get the `authorization_url`", "in": "query", "name": "forward", "required": true, "schema": {"type": "string"}}], "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/get-org-oauth-app-linked-status"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"description": "OAuth application name", "in": "path", "name": "app_name", "required": true, "schema": {"$ref": "#/components/schemas/oauth_app_name"}}], "post": {"description": "Add Jamf, VMware Authorization With Mist Portal", "operationId": "addOrgOauthAppAccounts", "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/add-org-oauth-app-accounts"}, "put": {"description": "Update Zoom, Teams, Intune Authorization.\n\nRequest Payload, These Field And Values Will Be Specific To Each Of The Third Party Apps Accounts.", "operationId": "updateOrgOauthAppAccounts", "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/update-org-oauth-app-accounts"}}, "paths": {"{account_id}": {"specs": {"delete": {"description": "Delete Org Level OAuth Application Authorization With Mist Portal", "operationId": "deleteOrgOauthAppAuthorization", "tags": ["Orgs Linked Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/linked-applications/delete-org-oauth-app-authorization"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"description": "OAuth application name", "in": "path", "name": "app_name", "required": true, "schema": {"$ref": "#/components/schemas/oauth_app_name"}}, {"$ref": "#/components/parameters/account_id"}]}}}}}}}}, "sitegroups": {"specs": {"get": {"description": "Get List of Org Site Groups", "operationId": "listOrgSiteGroups", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Sitegroups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sitegroups/list-org-site-groups"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Site Group", "operationId": "createOrgSiteGroup", "tags": ["Orgs Sitegroups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sitegroups/create-org-site-group"}}, "paths": {"{sitegroup_id}": {"specs": {"delete": {"description": "Delete Org Site Group", "operationId": "deleteOrgSiteGroup", "tags": ["Orgs Sitegroups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sitegroups/delete-org-site-group"}, "get": {"description": "Get Org Site Group", "operationId": "getOrgSiteGroup", "tags": ["Orgs Sitegroups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sitegroups/get-org-site-group"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sitegroup_id"}], "put": {"description": "Update Org Site Group", "operationId": "updateOrgSiteGroup", "tags": ["Orgs Sitegroups"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sitegroups/update-org-site-group"}}}}}, "sites": {"specs": {"get": {"description": "Get List of Org Sites", "operationId": "listOrgSites", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sites/list-org-sites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Site", "operationId": "createOrgSite", "tags": ["Orgs Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sites/create-org-site"}}, "paths": {"count": {"specs": {"get": {"description": "Count Sites", "operationId": "countOrgSites", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_sites_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sites/count-org-sites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Sites", "operationId": "searchOrgSites", "parameters": [{"description": "if Advanced Analytic feature is enabled", "in": "query", "name": "analytic_enabled", "schema": {"type": "boolean"}}, {"description": "if App Waking feature is enabled", "in": "query", "name": "app_waking", "schema": {"type": "boolean"}}, {"description": "if Asset Tracking is enabled", "in": "query", "name": "asset_enabled", "schema": {"type": "boolean"}}, {"description": "if Auto Upgrade feature is enabled", "in": "query", "name": "auto_upgrade_enabled", "schema": {"type": "boolean"}}, {"description": "if Auto Upgrade feature is enabled", "in": "query", "name": "auto_upgrade_version", "schema": {"type": "string"}}, {"description": "site country code", "in": "query", "name": "country_code", "schema": {"type": "string"}}, {"description": "if Honeypot detection is enabled", "in": "query", "name": "honeypot_enabled", "schema": {"type": "boolean"}}, {"description": "site id", "in": "query", "name": "id", "schema": {"type": "string"}}, {"description": "if unconnected client are located", "in": "query", "name": "locate_unconnected", "schema": {"type": "boolean"}}, {"description": "if Mesh feature is enabled", "in": "query", "name": "mesh_enabled", "schema": {"type": "boolean"}}, {"description": "site name", "in": "query", "name": "name", "schema": {"type": "string"}}, {"description": "if Rogue detection is enabled", "in": "query", "name": "rogue_enabled", "schema": {"type": "boolean"}}, {"description": "if Remote Syslog is enabled", "in": "query", "name": "remote_syslog_enabled", "schema": {"type": "boolean"}}, {"description": "if managed mobility feature is enabled", "in": "query", "name": "rtsa_enabled", "schema": {"type": "boolean"}}, {"description": "if Virtual Network Assistant is enabled", "in": "query", "name": "vna_enabled", "schema": {"type": "boolean"}}, {"description": "if WIFI feature is enabled", "in": "query", "name": "wifi_enabled", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sites/search-org-sites"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{site_name}": {"paths": {"maps": {"paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/site_name"}], "post": {"description": "Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches\n\n#### Request\n\n```\n\"json\": a JSON string describing your upload\n\"file\": a binary file\n```", "operationId": "importOrgMapToSite", "tags": ["Orgs Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/maps/import-org-map-to-site"}}}}}}}}}, "sitetemplates": {"specs": {"get": {"description": "Get List of Org Site Templates", "operationId": "listOrgSiteTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/site-templates/list-org-site-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Site Template", "operationId": "createOrgSiteTemplates", "tags": ["Orgs Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/site-templates/create-org-site-templates"}}, "paths": {"{sitetemplate_id}": {"specs": {"delete": {"description": "Delete Org Site Template", "operationId": "deleteOrgSiteTemplate", "tags": ["Orgs Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/site-templates/delete-org-site-template"}, "get": {"description": "Get Org Site Template", "operationId": "getOrgSiteTemplate", "tags": ["Orgs Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/site-templates/get-org-site-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sitetemplate_id"}], "put": {"description": "Update Org Site Template", "operationId": "updateOrgSiteTemplate", "tags": ["Orgs Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/site-templates/update-org-site-template"}}}}}, "ssl_proxy_cert": {"specs": {"get": {"description": "Get Org SSL proxy Certificates", "operationId": "getOrgSslProxyCert", "tags": ["Orgs Cert"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/cert/get-org-ssl-proxy-cert"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "ssoroles": {"specs": {"get": {"description": "Get List of Org SSO Roles", "operationId": "listOrgSsoRoles", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso-roles/list-org-sso-roles"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org SSO Role", "operationId": "createOrgSsoRole", "tags": ["Orgs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso-roles/create-org-sso-role"}}, "paths": {"{ssorole_id}": {"specs": {"delete": {"description": "Delete Org SSO Role", "operationId": "deleteOrgSsoRole", "tags": ["Orgs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso-roles/delete-org-sso-role"}, "get": {"description": "Get Org SSO Role Details", "operationId": "getOrgSsoRole", "tags": ["Orgs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso-roles/get-org-sso-role"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/ssorole_id"}], "put": {"description": "Update Org SSO Role", "operationId": "updateOrgSsoRole", "tags": ["Orgs SSO Roles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso-roles/update-org-sso-role"}}}}}, "ssos": {"specs": {"get": {"description": "Get List of Org SSO Configuration", "operationId": "listOrgSsos", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/list-org-ssos"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org SSO Configuration", "operationId": "createOrgSso", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/create-org-sso"}}, "paths": {"{sso_id}": {"specs": {"delete": {"description": "Delete Org SSO Configuration", "operationId": "deleteOrgSso", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/delete-org-sso"}, "get": {"description": "Get Org SSO Configuration Details", "operationId": "getOrgSso", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/get-org-sso"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sso_id"}], "put": {"description": "Update Org SSO Configuration", "operationId": "updateOrgSso", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/update-org-sso"}}, "paths": {"failures": {"specs": {"get": {"description": "Get List of Org SSO Latest Failures", "operationId": "listOrgSsoLatestFailures", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/list-org-sso-latest-failures"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sso_id"}]}}, "metadata": {"specs": {"get": {"description": "Get Org SAML Metadata", "operationId": "getOrgSamlMetadata", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/get-org-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sso_id"}]}}, "metadata.xml": {"specs": {"get": {"description": "Download Org SAML Metdata\n\nExample of metadata.xml:\n```xml\n<?xml version=\"1.0\" encoding=\"UTF-8\"?><md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" validUntil=\"2027-10-12T21:59:01Z\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\">\n    <md:SPSSODescriptor AuthnRequestsSigned=\"false\" WantAssertionsSigned=\"true\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">\n        <md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/logout\" />\n        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>\n        <md:AssertionConsumerService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://api.mist.com/api/v1/saml/5hdF5g/login\" index=\"0\" isDefault=\"true\"/>\n        <md:AttributeConsumingService index=\"0\">\n            <md:ServiceName xml:lang=\"en-US\">Mist</md:ServiceName>\n            <md:RequestedAttribute Name=\"Role\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"true\"/>\n            <md:RequestedAttribute Name=\"FirstName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n            <md:RequestedAttribute Name=\"LastName\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:basic\" isRequired=\"false\"/>\n        </md:AttributeConsumingService>\n    </md:SPSSODescriptor>\n</md:EntityDescriptor>\n```", "operationId": "downloadOrgSamlMetadata", "tags": ["Orgs SSO"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/sso/download-org-saml-metadata"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/sso_id"}]}}}}}}, "ssr": {"paths": {"upgrade": {"specs": {"get": {"description": "Get List of Org SSR Upgrades", "operationId": "listOrgSsrUpgrades", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-org-ssr-upgrades"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Upgrade Org SSRs", "operationId": "upgradeOrgSsrs", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-org-ssrs"}}, "paths": {"{upgrade_id}": {"paths": {"cancel": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/upgrade_id"}], "post": {"description": "Best effort to cancel an upgrade. Devices which are already upgraded wont be touched\u21b5\n", "operationId": "cancelOrgSsrUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/cancel-org-ssr-upgrade"}}}}}}}, "versions": {"specs": {"get": {"description": "Get available version for SSR", "operationId": "listOrgAvailableSsrVersions", "parameters": [{"in": "query", "name": "channel", "schema": {"type": "string"}}], "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-org-available-ssr-versions"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "stats": {"specs": {"get": {"description": "Get Org Stats", "operationId": "getOrgStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/get-org-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"assets": {"specs": {"get": {"description": "Get List of Org Assets Stats", "operationId": "listOrgAssetsStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/assets/list-org-assets-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count Org Assets", "operationId": "countOrgAssetsByDistanceField", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_asset_count_distinct"}}], "tags": ["Orgs Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/assets/count-org-assets-by-distance-field"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search for Org Assets", "operationId": "searchOrgAssets", "parameters": [{"in": "query", "name": "site_id", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "device_name", "schema": {"type": "string"}}, {"in": "query", "name": "name", "schema": {"type": "string"}}, {"in": "query", "name": "map_id", "schema": {"type": "string"}}, {"in": "query", "name": "ibeacon_uuid", "schema": {"type": "string"}}, {"in": "query", "name": "ibeacon_major", "schema": {"type": "string"}}, {"in": "query", "name": "ibeacon_minor", "schema": {"type": "string"}}, {"in": "query", "name": "eddystone_uid_namespace", "schema": {"type": "string"}}, {"in": "query", "name": "eddystone_uid_instance", "schema": {"type": "string"}}, {"in": "query", "name": "eddystone_url", "schema": {"type": "string"}}, {"in": "query", "name": "ap_mac", "schema": {"type": "string"}}, {"in": "query", "name": "beam", "schema": {"type": "integer"}}, {"in": "query", "name": "rssi", "schema": {"type": "integer"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/assets/search-org-assets"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "bgp_peers": {"paths": {"count": {"specs": {"get": {"description": "Count Org BGP Stats", "operationId": "countOrgBgpStats", "tags": ["Orgs Stats - BGP Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/bgp-peers/count-org-bgp-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org BGP Stats", "operationId": "searchOrgBgpStats", "tags": ["Orgs Stats - BGP Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/bgp-peers/search-org-bgp-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "devices": {"specs": {"get": {"description": "Get List of Org Devices stats\nThis API renders some high-level device stats, pagination is assumed and returned in response header (as the response is an array)", "operationId": "listOrgDevicesStats", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type_with_all"}}, {"in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/device_status"}}, {"in": "query", "name": "site_id", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "EVPN Topology ID", "in": "query", "name": "evpntopo_id", "schema": {"type": "string"}}, {"description": "if `evpn_unused`==`true`, find EVPN eligible switches which don\u2019t belong to any EVPN Topology yet", "in": "query", "name": "evpn_unused", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/fields"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/devices/list-org-devices-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "mxedges": {"specs": {"get": {"description": "Get List of Org MxEdge Stats", "operationId": "listOrgMxEdgesStats", "parameters": [{"description": "filter for site level mist edges", "in": "query", "name": "for_site", "schema": {"default": false, "type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/mxedges/list-org-mx-edges-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}, "paths": {"{mxedge_id}": {"specs": {"get": {"description": "Get Org MxEdge Details Stats", "operationId": "getOrgMxEdgeStats", "parameters": [{"in": "query", "name": "for_site", "schema": {"default": false, "type": "boolean"}}], "tags": ["Orgs Stats - MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/mxedges/get-org-mx-edge-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/mxedge_id"}]}}}}, "otherdevices": {"paths": {"{device_mac}": {"specs": {"get": {"description": "Get Otherdevice Stats", "operationId": "getOrgOtherDeviceStats", "tags": ["Orgs Stats - Other Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/other-devices/get-org-other-device-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/device_mac"}]}}}}, "ports": {"paths": {"search": {"specs": {"get": {"description": "Search Switch / Gateway Ports", "operationId": "searchOrgSwOrGwPorts", "parameters": [{"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Output errors", "in": "query", "name": "tx_errors", "schema": {"type": "integer"}}, {"description": "Input errors", "in": "query", "name": "rx_errors", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "Limit on number of dynamically learned macs", "in": "query", "name": "mac_limit", "schema": {"type": "integer"}}, {"description": "Number of mac addresses in the forwarding table", "in": "query", "name": "mac_count", "schema": {"type": "integer"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/search_org_sw_or_gw_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/search_org_sw_or_gw_ports_stp_role"}}, {"description": "if `up`==`true` && has Authenticator role", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/search_org_sw_or_gw_ports_auth_state"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/ports/search-org-sw-or-gw-ports"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "sites": {"specs": {"get": {"description": "Get List of Org Site Stats", "operationId": "listOrgSiteStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/sites/list-org-site-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "switch_ports": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Switch/Gateway Ports", "operationId": "countOrgSwitchPorts", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_switch_port_count_distinct"}}, {"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/count_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/count_ports_stp_role"}}, {"description": "if `up`==`true`", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/count_ports_auth_state"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/ports/count-org-switch-ports"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "tunnels": {"paths": {"count": {"specs": {"get": {"description": "Count Mist Tunnels Stats", "operationId": "countOrgTunnelsStats", "parameters": [{"description": "- If `type`==`wxtunnel`: wxtunnel_id / ap / remote_ip / remote_port / state / mxedge_id / mxcluster_id / site_id / peer_mxedge_id; default is wxtunnel_id \n- If `type`==`wan`: mac / site_id / node / peer_ip / peer_host/ ip / tunnel_name / protocol / auth_algo / encrypt_algo / ike_version / last_event / up", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_tunnel_count_distinct"}}, {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/org_tunnel_type_count"}}], "tags": ["Orgs Stats - Tunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/tunnels/count-org-tunnels-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Tunnels Stats", "operationId": "searchOrgTunnelsStats", "parameters": [{"description": "if `type`==`wxtunnel`", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "if `type`==`wxtunnel`", "in": "query", "name": "wxtunnel_id", "schema": {"type": "string"}}, {"description": "if `type`==`wxtunnel`", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "node", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "peer_ip", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "peer_host", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "tunnel_name", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "protocol", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "auth_algo", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "encrypt_algo", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "ike_version", "schema": {"type": "string"}}, {"description": "if `type`==`wan`", "in": "query", "name": "up", "schema": {"type": "string"}}, {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/tunnel_type"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Stats - Tunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/tunnels/search-org-tunnels-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "vpn_peers": {"paths": {"count": {"specs": {"get": {"description": "Count Org Peer Path Statgs", "operationId": "countOrgPeerPathStats", "parameters": [{"in": "query", "name": "distinct", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Stats - VPN Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/vpn-peers/count-org-peer-path-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Peer Path Stats", "operationId": "searchOrgPeerPathStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Stats - VPN Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/stats/vpn-peers/search-org-peer-path-stats"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}}}, "subscriptions": {"specs": {"delete": {"description": "Unsubscribe from Org Alarms/Reports\nSubscriptions define how Org Alarms/Reports are delivered to whom", "operationId": "unsubscribeOrgAlarmsReports", "tags": ["Orgs Subscriptions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/subscriptions/unsubscribe-org-alarms-reports"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Subscribe to Org Alarms/Reports\nSubscriptions define how Org Alarms/Reports are delivered to whom", "operationId": "subscribeOrgAlarmsReports", "tags": ["Orgs Subscriptions"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/subscriptions/subscribe-org-alarms-reports"}}}, "templates": {"specs": {"get": {"description": "Get List of Org WLAN Templates", "operationId": "listOrgTemplates", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/list-org-templates"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Template", "operationId": "createOrgTemplate", "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/create-org-template"}}, "paths": {"{template_id}": {"specs": {"delete": {"description": "Delete Org Template", "operationId": "deleteOrgTemplate", "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/delete-org-template"}, "get": {"description": "Get Org Template Details", "operationId": "getOrgTemplate", "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/get-org-template"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/template_id"}], "put": {"description": "Update Org Template", "operationId": "updateOrgTemplate", "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/update-org-template"}}, "paths": {"clone": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/template_id"}], "post": {"description": "Clone Org Template", "operationId": "cloneOrgTemplate", "tags": ["Orgs WLAN Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlan-templates/clone-org-template"}}}}}}}, "tickets": {"specs": {"get": {"description": "Get List of Tickets of an Org", "operationId": "listOrgTickets", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/list-org-tickets"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create a support ticket", "operationId": "createOrgTicket", "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/create-org-ticket"}}, "paths": {"count": {"specs": {"get": {"description": "Count Org Tickets", "operationId": "countOrgTickets", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_tickets_count_distinct"}}], "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/count-org-tickets"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{ticket_id}": {"specs": {"get": {"description": "Get support ticket details", "operationId": "getOrgTicket", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/get-org-ticket"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/ticket_id"}], "put": {"description": "Update support ticket", "operationId": "updateOrgTicket", "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/update-org-ticket"}}, "paths": {"attachments": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/ticket_id"}], "post": {"description": "Get Org ticket Attachment", "operationId": "UploadrgTicketAttachment", "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/uploadrg-ticket-attachment"}}, "paths": {"{attachment_id}": {"specs": {"get": {"description": "Get Org ticket Attachment", "operationId": "GetOrgTicketAttachment", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/get-org-ticket-attachment"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/ticket_id"}, {"$ref": "#/components/parameters/attachment_id"}]}}}}, "comments": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/ticket_id"}], "post": {"description": "Add Comment to support ticket", "operationId": "addOrgTicketComment", "tags": ["Orgs Tickets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/tickets/add-org-ticket-comment"}}}}}}}, "troubleshoot": {"specs": {"get": {"description": "Troubleshoot sites, devices, clients, and wired clientsfor maximum of last 7 days from current time. See search APIs for device information:\n- [search Device](/#operations/searchOrgDevices)\n- [search Wireless Client](/#operations/searchOrgWirelessClients)\n- [search Wired Client](/#operations/searchOrgWiredClients)\n- [search Wan Client](/#operations/searchOrgWanClients)\n\n**NOTE**: requires Marvis subscription license", "operationId": "troubleshootOrg", "parameters": [{"description": "**required** when troubleshooting device or a client", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "**required** when troubleshooting site", "in": "query", "name": "site_id", "schema": {"format": "uuid", "type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"description": "when troubleshooting site, type of network to troubleshoot", "in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/troubleshoot_type"}}], "tags": ["Orgs Marvis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/marvis/troubleshoot-org"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "usermacs": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org User MACs\n\n### Usermacs import CSV file format\nmac,labels,vlan,notes \n921b638445cd,\u201dbldg1,flor1\u201d,vlan-100 \n721b638445ef,\u201dbldg2,flor2\u201d,vlan-101,Canon Printers \n721b638445ee,\u201dbldg3,flor3\u201d,vlan-102 \n921b638445ce,\u201dbldg4,flor4\u201d,vlan-103 \n921b638445cf,\u201dbldg5,flor5\u201d,vlan-104", "operationId": "createOrgUserMacs", "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/create-org-user-macs"}}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Import Org User MACs\n\n### CSV Import example\n```csv \nmac,labels,vlan,notes,name,radius_group\n921b638445cd,\"bldg1,flor1\",vlan-100\n721b638445ef,\"bldg2,flor2\",vlan-101,Canon Printers\n721b638445ee,\"bldg3,flor3\",vlan-102,Printer2,VIP\n921b638445ce,\"bldg4,flor4\",vlan-103\n921b638445cf,\"bldg5,flor5\",vlan-104\n````", "operationId": "importOrgUserMacs", "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/import-org-user-macs"}}}, "search": {"specs": {"get": {"description": "Search Org User MACs", "operationId": "searchOrgUserMacs", "parameters": [{"description": "partial/full MAC addres", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "optional, array of strings of labels", "in": "query", "name": "labels", "schema": {"$ref": "#/components/schemas/search_org_user_macs_labels"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/search-org-user-macs"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{usermac_id}": {"specs": {"delete": {"description": "Delete Org User MAC", "operationId": "deleteOrgUserMac", "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/delete-org-user-mac"}, "get": {"description": "Get Org User MAC", "operationId": "getOrgUserMac", "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/get-org-user-mac"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/usermac_id"}], "put": {"description": "Update Org User MAC", "operationId": "updateOrgUserMac", "tags": ["Orgs User MACs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/user-macs/update-org-user-mac"}}}}}, "vars": {"paths": {"search": {"specs": {"get": {"description": "Search vars\n\nExample: /api/v1/orgs/:org_id/vars/search?vars=*", "operationId": "searchOrgVars", "parameters": [{"in": "query", "name": "site_id", "schema": {"type": "string"}}, {"in": "query", "name": "vars", "schema": {"type": "string"}}, {"in": "query", "name": "src", "schema": {"$ref": "#/components/schemas/var_source"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Vars"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vars/search-org-vars"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "vpns": {"specs": {"get": {"description": "Get List of Org VPNs", "operationId": "listOrgsVpns", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vpns/list-orgs-vpns"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org VPN", "operationId": "createOrgVpns", "tags": ["Orgs VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vpns/create-org-vpns"}}, "paths": {"{vpn_id}": {"specs": {"delete": {"description": "delete Org Vpn", "operationId": "deleteOrgVpn", "tags": ["Orgs VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vpns/delete-org-vpn"}, "get": {"description": "getOrgVpn", "operationId": "getOrgVpn", "tags": ["Orgs VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vpns/get-org-vpn"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/vpn_id"}], "put": {"description": "update Org Vpn", "operationId": "updateOrgVpn", "tags": ["Orgs VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/vpns/update-org-vpn"}}}}}, "wan_client": {"paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Org WAN Client-Events", "operationId": "countOrgWanClientEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_wan_clients_events_count_distinct"}}, {"$ref": "#/components/parameters/client_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wan/count-org-wan-client-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}}}, "wan_clients": {"paths": {"count": {"specs": {"get": {"description": "Count Org WAN Clients", "operationId": "countOrgWanClients", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_wan_clients_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wan/count-org-wan-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "events": {"paths": {"search": {"specs": {"get": {"description": "Search Org WAN Client Events", "operationId": "searchOrgWanClientEvents", "parameters": [{"$ref": "#/components/parameters/client_event_type"}, {"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "client IP", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "Manufacture", "in": "query", "name": "mfg", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wan/search-org-wan-client-events"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Org WAN Clients", "operationId": "searchOrgWanClients", "parameters": [{"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "client IP", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "network", "in": "query", "name": "network", "schema": {"type": "string"}}, {"description": "IP source", "in": "query", "name": "ip_src", "schema": {"type": "string"}}, {"description": "Manufacture", "in": "query", "name": "mfg", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wan/search-org-wan-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}}}, "webhooks": {"specs": {"get": {"description": "Get List of Org Webhooks", "operationId": "listOrgWebhooks", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/list-org-webhooks"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Webhook\n\n**N.B**. For org webhooks, only alarms/audits/client-info/client-join/client-sessions/device_events/device-updowns/mxedge_events Infrastructure topics are supported.", "operationId": "createOrgWebhook", "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/create-org-webhook"}}, "paths": {"{webhook_id}": {"specs": {"delete": {"description": "Delete Org Webhook", "operationId": "deleteOrgWebhook", "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/delete-org-webhook"}, "get": {"description": "Get Org Webhook Details", "operationId": "getOrgWebhook", "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/get-org-webhook"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/webhook_id"}], "put": {"description": "Update Org Webhook", "operationId": "updateOrgWebhook", "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/update-org-webhook"}}, "paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Org Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping", "operationId": "countOrgWebhooksDeliveries", "parameters": [{"in": "query", "name": "error", "schema": {"type": "string"}}, {"in": "query", "name": "status_code", "schema": {"type": "integer"}}, {"description": "webhook delivery status", "in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/webhook_delivery_status"}}, {"description": "webhook topic", "in": "query", "name": "topic", "schema": {"$ref": "#/components/schemas/webhook_delivery_topic"}}, {"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/webhook_delivery_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/count-org-webhooks-deliveries"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/webhook_id"}]}}, "search": {"specs": {"get": {"description": "Search Org Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping", "operationId": "searchOrgWebhooksDeliveries", "parameters": [{"in": "query", "name": "error", "schema": {"type": "string"}}, {"in": "query", "name": "status_code", "schema": {"type": "integer"}}, {"description": "webhook delivery status", "in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/webhook_delivery_status"}}, {"description": "webhook topic", "in": "query", "name": "topic", "schema": {"$ref": "#/components/schemas/webhook_delivery_topic"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/search-org-webhooks-deliveries"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/webhook_id"}]}}}}, "ping": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/webhook_id"}], "post": {"description": "send a Ping event to the webhook", "operationId": "pingOrgWebhook", "tags": ["Orgs Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/webhooks/ping-org-webhook"}}}}}}}, "wired_clients": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Clients\n\nNote: For list of avaialable `type` values, please refer to [listClientEventsDefinitions](/#operations/listClientEventsDefinitions)", "operationId": "countOrgWiredClients", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/org_wired_clients_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Clients - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wired/count-org-wired-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "search": {"specs": {"get": {"description": "Search for Wired Clients in org\n\nNote: For list of avaialable `type` values, please refer to [listClientEventsDefinitions](/#operations/listClientEventsDefinitions)", "operationId": "searchOrgWiredClients", "parameters": [{"description": "Site ID", "in": "query", "name": "site_id", "schema": {"type": "string"}}, {"description": "device mac (Gateway/Switch) where the client has connected to", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "port id where the client has connected to", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "vlan", "in": "query", "name": "vlan", "schema": {"type": "integer"}}, {"$ref": "#/components/parameters/ip"}, {"description": "client manufacturer", "in": "query", "name": "manufacture", "schema": {"type": "string"}}, {"description": "partial / full MAC address, hostname or username", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"description": "DHCP Hostname", "in": "query", "name": "dhcp_hostname", "schema": {"type": "string"}}, {"description": "DHCP FQDN", "in": "query", "name": "dhcp_fqdn", "schema": {"type": "string"}}, {"description": "DHCP Client Identifier", "in": "query", "name": "dhcp_client_identifier", "schema": {"type": "string"}}, {"description": "DHCP Vendor Class Identifier", "in": "query", "name": "dhcp_vendor_class_identifier", "schema": {"type": "string"}}, {"description": "DHCP Request Parameters", "in": "query", "name": "dhcp_request_params", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Orgs Clients - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/clients/wired/search-org-wired-clients"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{client_mac}": {"paths": {"coa": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "Trigger a CoA (change of authorization) against a Wiired client", "operationId": "reauthOrgDot1xWiredClient", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/reauth-org-dot1x-wired-client"}}}}}}}, "wlans": {"specs": {"get": {"description": "Get List of Org Wlans", "operationId": "listOrgWlans", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/list-org-wlans"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org Wlan", "operationId": "createOrgWlan", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/create-org-wlan"}}, "paths": {"{wlan_id}": {"specs": {"delete": {"description": "Delete Org WLAN", "operationId": "deleteOrgWlan", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/delete-org-wlan"}, "get": {"description": "Get Org Wlan Detail", "operationId": "getOrgWLAN", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/get-org-w-l-a-n"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wlan_id"}], "put": {"description": "Update Org Wlan", "operationId": "updateOrgWlan", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/update-org-wlan"}}, "paths": {"portal_image": {"specs": {"delete": {"description": "Delete Org WLAN Portal Image", "operationId": "deleteOrgWlanPortalImage", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/delete-org-wlan-portal-image"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wlan_id"}], "post": {"description": "Upload Org WLAN Portal Image", "operationId": "uploadOrgWlanPortalImage", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/upload-org-wlan-portal-image"}}}, "portal_template": {"specs": {"parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wlan_id"}], "put": {"description": "Update a Portal Template\n\n#### Sponsor Email Template\nSponsor Email Template supports following template variables:\n\n| **Name** | **Description** |\n| --- | --- |\n| approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized |\n| deny_url | Renders URL to reject the request |\n| guest_email | Renders Email ID of the guest |\n| guest_name | Renders Name of the guest |\n| field1 | Renders value of the Custom Field 1 |\n| field2 | Renders value of the Custom Field 2 |\n| company | Renders value of the Company field |\n| sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) |\n| auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |", "operationId": "updateOrgWlanPortalTemplate", "tags": ["Orgs Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wlans/update-org-wlan-portal-template"}}}}}}}, "wxrules": {"specs": {"get": {"description": "Get List of Org WxRules", "operationId": "listOrgWxRules", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxrules/list-org-wx-rules"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org WxRule", "operationId": "createOrgWxRule", "tags": ["Orgs WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxrules/create-org-wx-rule"}}, "paths": {"{wxrule_id}": {"specs": {"delete": {"description": "Delete Org WxRule", "operationId": "deleteOrgWxRule", "tags": ["Orgs WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxrules/delete-org-wx-rule"}, "get": {"description": "Get Org WxRule Details", "operationId": "getOrgWxRule", "tags": ["Orgs WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxrules/get-org-wx-rule"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wxrule_id"}], "put": {"description": "Update Org WxRule", "operationId": "updateOrgWxRule", "tags": ["Orgs WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxrules/update-org-wx-rule"}}}}}, "wxtags": {"specs": {"get": {"description": "Get List of Org WxLAN Tags", "operationId": "listOrgWxTags", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/list-org-wx-tags"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create WxLAN Tag", "operationId": "createOrgWxTag", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/create-org-wx-tag"}}, "paths": {"apps": {"specs": {"get": {"description": "Get Application List", "operationId": "getOrgApplicationList", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/get-org-application-list"}, "parameters": [{"$ref": "#/components/parameters/org_id"}]}}, "{wxtag_id}": {"specs": {"delete": {"description": "Delete WxLAN Tag", "operationId": "deleteOrgWxTag", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/delete-org-wx-tag"}, "get": {"description": "Get WxLAN Tag Details", "operationId": "getOrgWxTag", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/get-org-wx-tag"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wxtag_id"}], "put": {"description": "Update WxLAN Tag", "operationId": "updateOrgWxTag", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/update-org-wx-tag"}}, "paths": {"clients": {"specs": {"get": {"description": "Get Current Matching Clients of a WXLAN Tag", "operationId": "getOrgCurrentMatchingClientsOfAWxTag", "tags": ["Orgs WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtags/get-org-current-matching-clients-of-a-wx-tag"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wxtag_id"}]}}}}}}, "wxtunnels": {"specs": {"get": {"description": "Get List of Org WxLAN Tunnels", "operationId": "listOrgWxTunnels", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Orgs WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtunnels/list-org-wx-tunnels"}, "parameters": [{"$ref": "#/components/parameters/org_id"}], "post": {"description": "Create Org WxAN Tunnel", "operationId": "createOrgWxTunnel", "tags": ["Orgs WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtunnels/create-org-wx-tunnel"}}, "paths": {"{wxtunnel_id}": {"specs": {"delete": {"description": "Delete Org WxLAN Tunnel", "operationId": "deleteOrgWxTunnel", "tags": ["Orgs WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtunnels/delete-org-wx-tunnel"}, "get": {"description": "Get Org WxLAN Tunnel Details", "operationId": "getOrgWxTunnel", "tags": ["Orgs WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtunnels/get-org-wx-tunnel"}, "parameters": [{"$ref": "#/components/parameters/org_id"}, {"$ref": "#/components/parameters/wxtunnel_id"}], "put": {"description": "Update Org WxLAN Tunnel", "operationId": "updateOrgWxTunnel", "tags": ["Orgs WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/orgs/wxtunnels/update-org-wx-tunnel"}}}}}}}}}, "recover": {"specs": {"post": {"description": "Recover Password\nAn email will also be sent to the user with a link to https://manage.mist.com/verify/recover?token=:token", "operationId": "recoverPassword", "tags": ["Admins Recover Password"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/recover-password/recover-password"}}, "paths": {"verify": {"paths": {"{token}": {"specs": {"parameters": [{"$ref": "#/components/parameters/token"}], "post": {"description": "Verify Recover Password\nWith correct verification, the user will be authenticated. UI can then prompt for new password", "operationId": "verifyRecoverPasssword", "tags": ["Admins Recover Password"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins/recover-password/verify-recover-passsword"}}}}}}}, "register": {"specs": {"post": {"description": "Register a new admin and his/her org\nAn email will also be sent to the user with a link to `/verify/register?token={token}`\n\n### reCAPTCHA\nGoogle reCAPTCHA is the choice to prevent bot registration\n\nIt needs this \n\n&lt;script src='https://www.google.com/recaptcha/api.js' &gt;&lt;/script&gt;\n\nand this &lt;div&gt; in the desired place\n```html\n<div class=\"g-recaptcha\" data_sitekey=\"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd\"></div>\n```\n\nUse GET /api/v1/register/recaptcha to read the current setting.\nResponse example:\n```json\n{    \n  \"flavor\": \"google\",\n  \"required\": true,    \n  \"sitekey\": \"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd\"\n}\n```\n\n### hCaptcha\nAlternative to reCAPTCHA is hCaptcha to prevent bot registration\n\nIt needs this script\n\n&lt;script src='https://js.hcaptcha.com/1/api.js' async defer &gt;&lt;/script&gt;\n\nand this &lt;div&gt; in the desired place\n```html\n<div class=\"h-recaptcha\" data_sitekey=\"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd\"></div>\n```\n\nUse GET /api/v1/register/recaptcha?recaptcha_flavor=hcaptcha to read the current setting for hcaptcha with reply.\nResponse example:\n```json\n{\n  \"flavor\": \"hcaptcha\",\n  \"required\": true,\n  \"sitekey\": \"6LdAewsTAAAAAE25XKQhPEQ2FiMTft-WrZXQ5NUd\"\n}\"\n```", "operationId": "registerNewAdmin", "tags": ["Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins//register-new-admin"}}, "paths": {"recaptcha": {"specs": {"get": {"description": "Get Registration Information", "operationId": "getAdminRegistrationInfo", "parameters": [{"in": "query", "name": "recaptcha_flavor", "schema": {"$ref": "#/components/schemas/recaptcha_flavor"}}], "tags": ["Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins//get-admin-registration-info"}}}, "verify": {"paths": {"{token}": {"specs": {"parameters": [{"$ref": "#/components/parameters/token"}], "post": {"description": "Verify registration", "operationId": "verifyRegistration", "tags": ["Admins"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/admins//verify-registration"}}}}}}}, "self": {"specs": {"delete": {"description": "To delete ones account and every associated with it. The effects:\n\nthe account would be deleted\nany orphaned Org (that only has this account as admin) will be deleted\nalong with all data with Org (sites, wlans, devices) will be gone.", "operationId": "deleteSelf", "tags": ["Self Account"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/account/delete-self"}, "get": {"description": "Get \u2018whoami\u2019 and privileges (which org and which sites I have access to)", "operationId": "getSelf", "tags": ["Self Account"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/account/get-self"}, "put": {"description": "update Account Information", "operationId": "updateSelf", "tags": ["Self Account"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/account/update-self"}}, "paths": {"apitokens": {"specs": {"get": {"description": "Get List of Current User API Tokens", "operationId": "listApiTokens", "tags": ["Self API Token"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/api-token/list-api-tokens"}, "post": {"description": "Create API Token\nNote that the key is only available during creation time.", "operationId": "createApiToken", "tags": ["Self API Token"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/api-token/create-api-token"}}, "paths": {"{apitoken_id}": {"specs": {"delete": {"description": "Delete an API Token", "operationId": "deleteApiToken", "tags": ["Self API Token"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/api-token/delete-api-token"}, "get": {"description": "Get User API Token", "operationId": "getApiToken", "tags": ["Self API Token"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/api-token/get-api-token"}, "parameters": [{"$ref": "#/components/parameters/apitoken_id"}], "put": {"description": "Update User API Token", "operationId": "updateApiToken", "tags": ["Self API Token"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/api-token/update-api-token"}}}}}, "logs": {"specs": {"get": {"description": "Get List of change logs across all Orgs for current admin\nAudit logs records all administrative activities done by current admin across all orgs", "operationId": "listSelfAuditLogs", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Self Audit Logs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/audit-logs/list-self-audit-logs"}}}, "oauth": {"paths": {"{provider}": {"specs": {"get": {"description": "Obtain Authorization URL for Linking", "operationId": "getOauth2UrlForLinking", "parameters": [{"in": "query", "name": "forward", "schema": {"example": "http://manage.mist.com/oauth/callback.html", "type": "string"}}], "tags": ["Self OAuth2"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/oauth2/get-oauth2-url-for-linking"}, "parameters": [{"in": "path", "name": "provider", "required": true, "schema": {"type": "string"}}], "post": {"description": "Link Mist account with an OAuth2 Provider", "operationId": "linkOauth2MistAccount", "tags": ["Self OAuth2"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/oauth2/link-oauth2-mist-account"}}}}}, "subscriptions": {"specs": {"get": {"description": "Get List of all the subscriptions", "operationId": "listAlarmSubscriptions", "tags": ["Self Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/alarms/list-alarm-subscriptions"}}}, "two_factor": {"paths": {"token": {"specs": {"get": {"description": "Generate Secret Key for 2FA verification", "operationId": "generateSecretFor2faVerification", "parameters": [{"description": "if `by`==`qrcode`, returns the secret as a qrcode image", "in": "query", "name": "by", "schema": {"$ref": "#/components/schemas/mfa_secret_type"}}], "tags": ["Self MFA"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/mfa/generate-secret-for2fa-verification"}}}, "verify": {"specs": {"post": {"description": "Verify Two-factor (OTP)\n\nTo verify two-factor authentication by using a code generated by app (e.g. Google Authenticator, Authy). Upon successful verification, the `two_factor_passed` will be set to true if it hasn\u2019t already been.\n", "operationId": "verifyTwoFactor", "tags": ["Self MFA"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/mfa/verify-two-factor"}}}}}, "update": {"specs": {"post": {"description": "Change Email\nWe require the user to verify that they actually own the email address they intend to change it to.\n\nAfter the API call, the user will receive an email to the new email address with a link like https://manage.mist.com/verify/update?expire=:exp_time&email=:admin_email&token=:token\n\nUpon clicking the link, the user is provided with a login page to authenticate using existing credentials. After successful login, the email address of the user gets updated\n\n**Note**: The request parameter email can be used by UI to validate that the current session (if any) belongs to the admin or provide a login page (by pre-populating the email on login screen). UI can also use the request parameter expire to validate token expiry.", "operationId": "updateSelfEmail", "tags": ["Self Account"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/account/update-self-email"}}, "paths": {"verify": {"paths": {"{token}": {"specs": {"get": {"description": "Verify Email change", "operationId": "verifySelfEmail", "tags": ["Self Account"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/self/account/verify-self-email"}, "parameters": [{"$ref": "#/components/parameters/token"}]}}}}}}}}, "sites": {"paths": {"{site_id}": {"specs": {"delete": {"description": "Delete Site", "operationId": "deleteSite", "tags": ["Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites//delete-site"}, "get": {"description": "Get Site Info", "operationId": "getSiteInfo", "tags": ["Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites//get-site-info"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "put": {"description": "Update Site Info", "operationId": "updateSiteInfo", "tags": ["Sites"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites//update-site-info"}}, "paths": {"alarms": {"paths": {"ack": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Ack multiple Site Alarms", "operationId": "AckSiteMultipleAlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/ack-site-multiple-alarms"}}}, "ack_all": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Ack all Site Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.", "operationId": "ackSiteAllAlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/ack-site-all-alarms"}}}, "count": {"specs": {"get": {"description": "Count Site Alarms", "operationId": "countSiteAlarms", "parameters": [{"description": "Group by and count the alarms by some distinct field", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/alarm_count_disctinct"}}, {"description": "Name of the admins who have acked the alarms; accepts multiple values separated by comma", "in": "query", "name": "ack_admin_name", "schema": {"type": "string"}}, {"in": "query", "name": "acked", "schema": {"type": "boolean"}}, {"description": "Key-name of the alarms; accepts multiple values separated by comma", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "Alarm severity; accepts multiple values separated by comma", "in": "query", "name": "severity", "schema": {"type": "string"}}, {"description": "Alarm group name; accepts multiple values separated by comma", "in": "query", "name": "group", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/count-site-alarms"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Site Alarms", "operationId": "searchSiteAlarms", "parameters": [{"description": "Key-name of the alarms; accepts multiple values separated by comma", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "Name of the admins who have acked the alarms; accepts multiple values separated by comma", "in": "query", "name": "ack_admin_name", "schema": {"type": "string"}}, {"in": "query", "name": "acked", "schema": {"type": "boolean"}}, {"description": "Alarm severity; accepts multiple values separated by comma", "in": "query", "name": "severity", "schema": {"type": "string"}}, {"description": "Alarm group name; accepts multiple values separated by comma", "in": "query", "name": "group", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/search-site-alarms"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "unack": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Unack multiple Site Alarms", "operationId": "unackSiteMultipleAlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/unack-site-multiple-alarms"}}}, "unack_all": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Unack all Site Alarms\n\n**N.B.**: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.", "operationId": "unackSiteAllArlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/unack-site-all-arlarms"}}}, "{alarm_id}": {"paths": {"ack": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/alarm_id"}], "post": {"description": "Ack Site Alarm", "operationId": "ackSiteAlarm", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/ack-site-alarm"}}}, "unack": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/alarm_id"}], "post": {"description": "Unack Site Alarm", "operationId": "unackSiteAlarm", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/unack-site-alarm"}}}}}}}, "anomaly": {"paths": {"client": {"paths": {"{client_mac}": {"paths": {"{metric}": {"specs": {"get": {"description": "Get Client Anomaly Events", "operationId": "getSiteAnomalyEventsForClient", "tags": ["Sites Anomaly"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/anomaly/get-site-anomaly-events-for-client"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}, {"$ref": "#/components/parameters/metric"}]}}}}}}, "device": {"paths": {"{device_mac}": {"paths": {"{metric}": {"specs": {"get": {"description": "Get Device Anomaly Events", "operationId": "getSiteAnomalyEventsforDevice", "tags": ["Sites Anomaly"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/anomaly/get-site-anomaly-eventsfor-device"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/metric"}, {"$ref": "#/components/parameters/device_mac"}]}}}}}}, "{metric}": {"specs": {"get": {"description": "Get Site Anomaly Events", "operationId": "getSiteAnomalyEvents", "tags": ["Sites Anomaly"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/anomaly/get-site-anomaly-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/metric"}]}}}}, "apps": {"specs": {"get": {"description": "Get List of Site Applications", "operationId": "listSiteApps", "tags": ["Sites Applications"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/applications/list-site-apps"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "aptemplates": {"paths": {"derived": {"specs": {"get": {"description": "Get derived AP Templates for Site", "operationId": "listSiteApTemplateDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites AP Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ap-templates/list-site-ap-template-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "assetfilters": {"specs": {"get": {"description": "Get List of Site Asset Filters", "operationId": "listSiteAssetFilters", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/asset-filters/list-site-asset-filters"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site Asset Filter", "operationId": "createSiteAssetFilters", "tags": ["Sites Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/asset-filters/create-site-asset-filters"}}, "paths": {"{assetfilter_id}": {"specs": {"delete": {"description": "Deletes an existing BLE asset filter for the given site.", "operationId": "deleteSiteAssetFilter", "tags": ["Sites Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/asset-filters/delete-site-asset-filter"}, "get": {"description": "Get Site Asset Filter Details", "operationId": "getSiteAssetFilter", "tags": ["Sites Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/asset-filters/get-site-asset-filter"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/assetfilter_id"}], "put": {"description": "Updates an existing BLE asset filter for the given site.", "operationId": "updateSiteAssetFilter", "tags": ["Sites Asset Filters"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/asset-filters/update-site-asset-filter"}}}}}, "assets": {"specs": {"get": {"description": "Get List of Site Assets", "operationId": "listSiteAssets", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/list-site-assets"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site Asset", "operationId": "createSiteAsset", "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/create-site-asset"}}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Impert Site Assets. \n\nIt can be done via a CSV file or a JSON payload.\n\n## CSV File Format\n```csv\nname,mac\n\"asset_name\",5c5b53010101\n```", "operationId": "importSiteAssets", "parameters": [{"description": "API will replace the assets with same mac if provided `upsert`==`True`, otherwise will report in errors in response.", "in": "query", "name": "upsert", "schema": {"$ref": "#/components/schemas/import_site_assets_upsert"}}], "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/import-site-assets"}}}, "{asset_id}": {"specs": {"delete": {"description": "Delete Site Asset", "operationId": "deleteSiteAsset", "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/delete-site-asset"}, "get": {"description": "Get Site Asset Details", "operationId": "getSiteAsset", "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/get-site-asset"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/asset_id"}], "put": {"description": "Update Site Asset", "operationId": "updateSiteAsset", "tags": ["Sites Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/assets/update-site-asset"}}}}}, "beacons": {"specs": {"get": {"description": "Get List of Site Beacons", "operationId": "listSiteBeacons", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/beacons/list-site-beacons"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site Beacon", "operationId": "createSiteBeacon", "tags": ["Sites Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/beacons/create-site-beacon"}}, "paths": {"{beacon_id}": {"specs": {"delete": {"description": "Delete Site Beacon", "operationId": "deleteSiteBeacons", "tags": ["Sites Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/beacons/delete-site-beacons"}, "get": {"description": "Get Site Beacon Details", "operationId": "getSiteBeacon", "tags": ["Sites Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/beacons/get-site-beacon"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/beacon_id"}], "put": {"description": "Update Site Beacon", "operationId": "updateSiteBeacons", "tags": ["Sites Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/beacons/update-site-beacons"}}}}}, "clients": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Clients", "operationId": "countSiteWirelessClients", "parameters": [{"example": "hostname", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_clients_count_distinct"}}, {"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/ip"}, {"in": "query", "name": "vlan", "schema": {"type": "string"}}, {"in": "query", "name": "hostname", "schema": {"type": "string"}}, {"in": "query", "name": "os", "schema": {"type": "string"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "device", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/count-site-wireless-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "disconnect": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "To unauthorize multiple clients", "operationId": "disconnectSiteMultipleClients", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/disconnect-site-multiple-clients"}}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Client-Events", "operationId": "countSiteWirelessClientEvents", "parameters": [{"example": "type", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_client_events_count_distinct"}}, {"$ref": "#/components/parameters/client_event_type"}, {"description": "for assoc/disassoc events", "in": "query", "name": "reason_code", "schema": {"type": "integer"}}, {"description": "SSID Name", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_proto"}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/count-site-wireless-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Get Site Clients Events", "operationId": "searchSiteWirelessClientEvents", "parameters": [{"$ref": "#/components/parameters/client_event_type"}, {"description": "for assoc/disassoc events", "in": "query", "name": "reason_code", "schema": {"type": "integer"}}, {"description": "SSID Name", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_proto"}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/search-site-wireless-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Wireless Clients\n\n**NOTE**: fuzzy logic can be used with \u2018*\u2019, supported filters: mac, hostname, device, os, model. E.g. /clients/search?device=Mac*&hostname=jerry", "operationId": "searchSiteWirelessClients", "parameters": [{"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/ip"}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "device type, e.g. Mac, Nvidia, iPhone", "in": "query", "name": "device", "schema": {"type": "string"}}, {"description": "os, e.g. Sierra, Yosemite, Windows 10", "in": "query", "name": "os", "schema": {"type": "string"}}, {"description": "model, e.g. \u201cMBP 15 late 2013\u201d, 6, 6s, \u201c8+ GSM\u201d", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "AP mac where the client has connected to", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "partial / full MAC address, hostname, username, psk_name or ip", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/search-site-wireless-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "sessions": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Client Sessions", "operationId": "countSiteWirelessClientSessions", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_client_sessions_count_distinct"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "E.g. \u201cMac\u201d, \u201ciPhone\u201d, \u201cApple watch\u201d", "in": "query", "name": "client_family", "schema": {"type": "string"}}, {"description": "E.g. \u201cApple\u201d", "in": "query", "name": "client_manufacture", "schema": {"type": "string"}}, {"description": "E.g. \u201c8+\u201d, \u201cXS\u201d", "in": "query", "name": "client_model", "schema": {"type": "string"}}, {"description": "E.g. \u201cMojave\u201d, \u201cWindows 10\u201d, \u201cLinux\u201d", "in": "query", "name": "client_os", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/count-site-wireless-client-sessions"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Client Sessions", "operationId": "searchSiteWirelessClientSessions", "parameters": [{"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_band"}, {"description": "E.g. \u201cMac\u201d, \u201ciPhone\u201d, \u201cApple watch\u201d", "in": "query", "name": "client_family", "schema": {"type": "string"}}, {"description": "E.g. \u201cApple\u201d", "in": "query", "name": "client_manufacture", "schema": {"type": "string"}}, {"description": "E.g. \u201c8+\u201d, \u201cXS\u201d", "in": "query", "name": "client_model", "schema": {"type": "string"}}, {"description": "Username", "in": "query", "name": "client_username", "schema": {"type": "string"}}, {"description": "E.g. \u201cMojave\u201d, \u201cWindows 10\u201d, \u201cLinux\u201d", "in": "query", "name": "client_os", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "wlan_id", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/psk_id_query"}, {"description": "PSK Name", "in": "query", "name": "psk_name", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/search-site-wireless-client-sessions"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "unauthorize": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "This unauthorize clients (if they are guest) and disconnect them. From the guest\u2019s perspective, they will see the splash page again and go through the flow (e.g. Terms of Use) again.", "operationId": "unauthorizeSiteMultipleClients", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/unauthorize-site-multiple-clients"}}}, "{client_mac}": {"paths": {"coa": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "Trigger a CoA (change of authorization) against a Wireless client", "operationId": "reauthSiteDot1xWirelessClient", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/reauth-site-dot1x-wireless-client"}}}, "disconnect": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "This disconnect a client (and it\u2019s likely to connect back)", "operationId": "disconnectSiteWirelessClient", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/disconnect-site-wireless-client"}}}, "events": {"specs": {"get": {"description": "Get the list of events for a specific client", "operationId": "getSiteEventsForClient", "parameters": [{"description": "e.g. MARVIS_EVENT_CLIENT_DHCP_STUCK", "in": "query", "name": "type", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/dot11_proto"}, {"$ref": "#/components/parameters/dot11_band"}, {"in": "query", "name": "channel", "schema": {"type": "string"}}, {"in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wireless/get-site-events-for-client"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}]}}, "unauthorize": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "This unauthorize a client (if it\u2019s a guest) and disconnect it. From the guest\u2019s perspective, s/he will see the splash page again and go through the flow (e.g. Terms of Use) again.", "operationId": "unauthorizeSiteWirelessClient", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/unauthorize-site-wireless-client"}}}}}}}, "deviceprofiles": {"paths": {"derived": {"specs": {"get": {"description": "Retrieves the list of Device Profiles available for the Site", "operationId": "listSiteDeviceProfilesDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Device Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/device-profiles/list-site-device-profiles-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "devices": {"specs": {"get": {"description": "Get list of devices on the site.", "operationId": "listSiteDevices", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type_with_all"}}, {"$ref": "#/components/parameters/name"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/list-site-devices"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"ap_channels": {"specs": {"get": {"description": "Get a list of allowed channels (per channel width)", "operationId": "getSiteDeviceRadioChannels", "parameters": [{"description": "country code for the site (for AP config generation), in [two-character](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", "example": "US", "in": "query", "name": "country_code", "schema": {"type": "string"}}], "tags": ["Sites Devices - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wireless/get-site-device-radio-channels"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "config_history": {"paths": {"count": {"specs": {"get": {"description": "Counts the number of entries in device config history for distinct field with given filters", "operationId": "countSiteDeviceConfigHistory", "parameters": [{"in": "query", "name": "distinct", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/count-site-device-config-history"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search for entries in device config history", "operationId": "searchSiteDeviceConfigHistory", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "Device MAC Address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/search-site-device-config-history"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "count": {"specs": {"get": {"description": "Counts the number of entries in ap events history for distinct field with given filters", "operationId": "countSiteDevices", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_devices_count_distinct"}}, {"in": "query", "name": "hostname", "schema": {"type": "string"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "version", "schema": {"type": "string"}}, {"in": "query", "name": "mxtunnel_status", "schema": {"type": "string"}}, {"in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"in": "query", "name": "lldp_system_name", "schema": {"type": "string"}}, {"in": "query", "name": "lldp_system_desc", "schema": {"type": "string"}}, {"in": "query", "name": "lldp_port_id", "schema": {"type": "string"}}, {"in": "query", "name": "lldp_mgmt_addr", "schema": {"type": "string"}}, {"in": "query", "name": "map_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/count-site-devices"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Counts the number of entries in ap events history for distinct field with given filters", "operationId": "countSiteDeviceEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_device_events_count_distinct"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/device_event_type"}, {"in": "query", "name": "type_code", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/count-site-device-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Devices Events", "operationId": "searchSiteDeviceEvents", "parameters": [{"description": "device mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "event message", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "event time", "in": "query", "name": "timestamp", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/device_event_type"}, {"description": "Return last/recent event for passed in field", "example": "port_id", "in": "query", "name": "last_by", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/search-site-device-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "export": {"specs": {"get": {"description": "To download the exported device information", "operationId": "exportSiteDevices", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/export-site-devices"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "import": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Import Information for Multiple Devices\n\nCSV format:\n```csv\nmac,name,map_id,x,y,height,orientation,labels,band_24.power,band_24.bandwidth,band_24.channel,band_24.disabled,band_5.power,band_5.bandwidth,band_5.channel,band_5.disabled,band_6.power,band_6.bandwidth,band_6.channel,band_6.disabled\n5c5b53010101,\"AP 1\",845a23bf-bed9-e43c-4c86-6fa474be7ae5,30,10,2.3,45,\"guest, campus, vip\",1,20,0,false,0,40,0,false,17,80,0,false\n```", "operationId": "importSiteDevices", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/import-site-devices"}}}, "last_config": {"paths": {"count": {"specs": {"get": {"description": "Counts the number of entries in device config history for distinct field with given filters", "operationId": "countSiteDeviceLastConfig", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_device_last_config_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/count-site-device-last-config"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Device Last Configs", "operationId": "searchSiteDeviceLastConfigs", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "version", "schema": {"type": "string"}}, {"in": "query", "name": "name", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/search-site-device-last-configs"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "reprovision": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "To force all APs to reprovision itself again.", "operationId": "reprovisionSiteAllAps", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/reprovision-site-all-aps"}}}, "reset_radio_config": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Reset all APs in the Site to use RRM", "operationId": "resetSiteAllApsToUseRrm", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/reset-site-all-aps-to-use-rrm"}}}, "restart": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Note that only the devices that are connected will be restarted.", "operationId": "restartSiteMultipleDevices", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/restart-site-multiple-devices"}}}, "search": {"specs": {"get": {"description": "Search Device", "operationId": "searchSiteDevices", "parameters": [{"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "device MAC", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"description": "power_constrained", "in": "query", "name": "power_constrained", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/ip"}, {"description": "MxTunnel status, up / down", "in": "query", "name": "mxtunnel_status", "schema": {"$ref": "#/components/schemas/search_site_devices_mxtunnel_status"}}, {"description": "Mist Edge id, if AP is connecting to a Mist Edge", "in": "query", "name": "mxedge_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "LLDP system name", "in": "query", "name": "lldp_system_name", "schema": {"type": "string"}}, {"description": "LLDP system description", "in": "query", "name": "lldp_system_desc", "schema": {"type": "string"}}, {"description": "LLDP port id", "in": "query", "name": "lldp_port_id", "schema": {"type": "string"}}, {"description": "LLDP management ip address", "in": "query", "name": "lldp_mgmt_addr", "schema": {"type": "string"}}, {"description": "Channel of band_24", "in": "query", "name": "band_24_channel", "schema": {"type": "integer"}}, {"description": "Channel of band_5", "in": "query", "name": "band_5_channel", "schema": {"type": "integer"}}, {"description": "Channel of band_6", "in": "query", "name": "band_6_channel", "schema": {"type": "integer"}}, {"description": "Bandwidth of band_24", "in": "query", "name": "band_24_bandwidth", "schema": {"type": "integer"}}, {"description": "Bandwidth of band_5", "in": "query", "name": "band_5_bandwidth", "schema": {"type": "integer"}}, {"description": "Bandwidth of band_6", "in": "query", "name": "band_6_bandwidth", "schema": {"type": "integer"}}, {"description": "Port speed of eth0", "in": "query", "name": "eth0_port_speed", "schema": {"type": "integer"}}, {"description": "sort options", "in": "query", "name": "sort", "schema": {"$ref": "#/components/schemas/search_site_devices_sort"}}, {"description": "sort options in reverse order", "in": "query", "name": "desc_sort", "schema": {"$ref": "#/components/schemas/search_site_devices_desc_sort"}}, {"description": "whether to return device stats", "in": "query", "name": "stats", "schema": {"default": false, "type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/search-site-devices"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "send_ble_beacon": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Send arbitrary BLE Beacon for a period of time\n\nNote that only the devices that are connected will be restarted.", "operationId": "sendSiteDevicesArbitratryBleBeacon", "tags": ["Utilities Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/location/send-site-devices-arbitratry-ble-beacon"}}}, "upgrade": {"specs": {"get": {"description": "Get all upgrades for site", "operationId": "listSiteDeviceUpgrades", "parameters": [{"in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/device_upgrade_status"}}], "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-site-device-upgrades"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Upgrade Site Device\n\n**Note**: this call doesn\u2019t guarantee the devices to be upgraded right away (they may be offline)", "operationId": "upgradeSiteDevices", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-site-devices"}}, "paths": {"{upgrade_id}": {"specs": {"get": {"description": "Get Site Device Upgrade", "operationId": "getSiteDeviceUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/get-site-device-upgrade"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/upgrade_id"}]}, "paths": {"cancel": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/upgrade_id"}], "post": {"description": "Best effort to cancel an upgrade. Devices which are already upgraded wont be touched", "operationId": "cancelSiteDeviceUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/cancel-site-device-upgrade"}}}}}}}, "upgrade_bios": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Upgrade Bios on Multiple Device", "operationId": "upgradeSiteDevicesBios", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/upgrade-site-devices-bios"}}}, "upgrade_fpga": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Upgrade Bios on Multiple Device", "operationId": "upgradeSiteDevicesFpga", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/upgrade-site-devices-fpga"}}}, "versions": {"specs": {"get": {"description": "Get List of Available Device Versions", "operationId": "listSiteAvailableDeviceVersions", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type"}}, {"description": "fetch version for device model, use/combine with `type` as needed (for switch and gateway devices)", "in": "query", "name": "model", "schema": {"type": "string"}}], "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/list-site-available-device-versions"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "zeroize": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Zeroize all FIPS APs in the Site", "operationId": "zeroizeSiteFipsAllAps", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/zeroize-site-fips-all-aps"}}}, "{device_id}": {"specs": {"get": {"description": "Get Device Configuration", "operationId": "getSiteDevice", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/get-site-device"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "put": {"description": "Update Device Configuration", "operationId": "updateSiteDevice", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/update-site-device"}}, "paths": {"arp": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "ARP can be performed on the Device. The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{ \n \"event\": \"data\", \n \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\", \n \"data\": { \n   \"session\": \"session_id\", \n   \"raw\": \n   \"Output\": \"\\tMAC\\t\\tDEV\\tVLAN\\tRx Packets\\t\\t Rx Bytes\\t\\tTx Packets\\t\\t Tx Bytes\\tFlows\\tIdle sec\\n-----------------------------------------------------------------------------------------------------------------------\"\n  } \n}\n```", "operationId": "arpFromDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/arp-from-device"}}}, "bounce_port": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Port Bounce can be performed from Switch/Gateway.\n\n **Note:** Ports starting with vme, ae, irb, and HA control ports (for SSR only) are not supported\n\nThe output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\",\n    \"data\": {\n        \"session\": \"session_id\",\n        \"raw\": \"Port bounce complete.\"\n    }\n}\n```", "operationId": "bounceDevicePort", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/bounce-device-port"}}}, "cable_test": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple command issued against the same Switch at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\",\n    \"data\": {\n        \"session\": \"session_id\",\n        \"raw\": \"Interface TDR detail:\\nTest status : Test successfully executed  ge-0/0/0\\n\"\n    }\n}\n```", "operationId": "cableTestFromSwitch", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/cable-test-from-switch"}}}, "check_radius_server": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Ping test from the AP to confirm \u2018reachability\u2019 of the Radius server. Utilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the Radius Server \u2018availability\u2019 .", "operationId": "startSiteSwitchRadiusSyntheticTest", "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/start-site-switch-radius-synthetic-test"}}}, "clear_arp": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear ARP cache for SSR, SRX and Switch\n\nClear the entire ARP cache or a subset if arguments are provided.\n\n*Note*: port_id is optional if neither vlan nor ip is specified", "operationId": "clearSiteSsrArpCache", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/clear-site-ssr-arp-cache"}}}, "clear_bgp": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear routes associated with one or all BGP neighbors", "operationId": "clearSiteSsrBgpRoutes", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/clear-site-ssr-bgp-routes"}}}, "clear_bpdu_error": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear bridge protocol data unit (BPDU) error condition caused by the detection of a possible bridging loop from Spanning Tree Protocol (STP) operation that renders the port unoperational.", "operationId": "clearBpduErrosFromPortsOnSwitch", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/clear-bpdu-erros-from-ports-on-switch"}}}, "clear_mac_table": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear MAC Table from the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n", "operationId": "clearSiteDeviceMacTable", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/clear-site-device-mac-table"}}}, "clear_macs": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear all learned MAC addresses, including persistent MAC addresses, on a port.", "operationId": "clearAllLearnedMacsFromPortOnSwitch", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/clear-all-learned-macs-from-port-on-switch"}}}, "clear_policy_hit_count": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear application policy hit counts for all the policies", "operationId": "clearSiteDevicePolicyHitCount", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/clear-site-device-policy-hit-count"}}}, "clear_session": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Clear session", "operationId": "clearSiteDeviceSession", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/clear-site-device-session"}}}, "config_cmd": {"specs": {"get": {"description": "Get Config CLI Commands\nFor a brown-field switch deployment where we adopted the switch through Adoption Command, we do not wipe out / overwrite the existing config automatically. Instead, we generate CLI commands that we would have generated. The user can inspect, modify, and incorporate this into their existing config manually.\n\nOnce they feel comfortable about the config we generate, they can enable allow_mist_config where we will take full control of their config like a claimed switch", "operationId": "getSiteDeviceConfigCmd", "parameters": [{"description": "Make output cmds sorted (for better readability) or not.", "in": "query", "name": "sort", "schema": {"default": false, "type": "boolean"}}], "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/get-site-device-config-cmd"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}]}}, "ha": {"specs": {"delete": {"description": "Delete HA Cluster", "operationId": "deleteSiteDeviceHaCluster", "tags": ["Sites Devices - WAN Cluster"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wan-cluster/delete-site-device-ha-cluster"}, "get": {"description": "Delete HA Cluster", "operationId": "GetSiteDeviceHaClusterNode", "tags": ["Sites Devices - WAN Cluster"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wan-cluster/get-site-device-ha-cluster-node"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "## Create HA Cluster\nBoth nodes has to be in the same site. We expect the user to configure ha_sync / ha_data port in port_configs already\n\n### SRX cabling\n\nsee [Chassis Cluster User Guide for SRX Series Devices](https://www.juniper.net/documentation/us/en/software/junos/chassis-cluster-security-devices/topics/concept/chassis-cluster-srx-series-node-interface-understanding.html) Here\u2019s the recommended cabling.\n\n#### SRX300\n\nFrom ZTP / default state, ge-0/0/0 and ge-0/0/7 (SFP) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended)\n\n1.  form cluster in UI\n2.  configure ge-0/0/7,ge-1/0/7 for WAN (reth0)\n3.  configure ge-0/0/2,ge-1/0/2 for ha_data\n4.  configure ge-0/0/3- for LAN or additional WAN e.g.\n    \n\n``` json\n{\n    \"port_config\": {\n        \"ge-0/0/2,ge-1/0/2\": {\n            \"usage\": \"ha_data\"\n        },\n        \"ge-0/0/7,ge-1/0/7\": {\n            \"usage\": \"wan\",\n            \"redundant\": true,\n            \"reth_idx\": 0,\n            \"ip_config\": {\"type\": \"dhcp\"}\n        },\n    }\n}\n\n```\n\n1.  connect ge-0/0/1 back to back for ha_control\n2.  connect ge-0/0/2 back to back for ha_data\n3.  connect both ge-0/0/7 to uplink switch to WAN and to reach Mist\n4.  power up both devices\n5.  it takes about 30 minutes for the cluster to form\n    \n\n#### SRX320\n\nFrom ZTP / default state, ge-0/0/0, ge-0/0/7 (SFP) and cl-1/0/0 (LTE) are default WAN ports and will get DHCP IP. However, ge-0/0/0 becomes OOB/fxp0 after cluster is enabled (i.e. using it for reach Mist is not recommended)\n\n##### ZTP via ge-0/0/7\n\nSimilar to SRX300\n\n##### ZTP via cl-1/0/0 (LTE)\n\n1.  form cluster in UI\n2.  configure cl-1/0/0, cl-3/0/0 as WAN (reth0)\n3.  configure ge-0/0/2,ge-3/0/2 for ha_data\n4.  same as above\n    \n\n#### SRX340 / SRX345 / SRX380\n\nSRX340/SRX345 has dedicated OOB/fxp0 ports\n\n1.  form cluster in UI\n2.  configure ge-0/0/0,ge-5/0/0 for WAN (reth0)\n3.  configure ge-0/0/2,ge-5/0/2 for ha_data\n4.  configure ge-0/0/3- for LAN or additional WAN\n5.  connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n6.  connect ge-0/0/1 back-to-back for ha_control\n7.  connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used\n8.  connect ge-0/0/3- to LAN or additional WANs\n    \n\n#### SRX550\n\nge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity\n\n1.  connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)\n2.  connect ge-0/0/1 back-to-back for ha_control\n3.  connect ge-0/0/2 back-to-back for ha_data (fabric)\n4.  connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)\n5.  connect ge-0/0/4- to LAN or additional WANs\n    \n\n#### SRX1500\n\nSRX1500 has, additionally, dedicated HA Control port\n\n1.  form cluster in UI\n2.  configure ge-0/0/0,ge-5/0/0 for WAN (reth0)\n3.  configure ge-0/0/1,ge-5/0/1 for ha_data\n4.  configure ge-0/0/2- for LAN or additional WAN\n5.  connect dedicated ha_control back-to-back\n6.  connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7.  connect ge-0/0/1 back-to-back for ha_data\n8.  connect ge-0/0/2- to LAN or additional WANs\n    \n\n#### SRX4100\n\nSRX4100 has dedicated ha_control and ha_data (fabric) ports\n\n1.  connect dedicated ha_control back-to-back\n2.  connect dedicated ha_data back-to-back\n3.  connect xe-0/0/0 to WAN to reach Mist\n4.  connect xe-0/0/1- to LAN or additional WANs\n    \n\n#### VSRX\n\nWhen standalone, VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N When clustered, VSRX has fxp0, em0, then ge-0/0/0-N\n\n1.  connect net0 (fxp0) to WAN to reach Mist\n2.  connect net1 back-to-back for ha_control\n3.  connect net2 (ge-0/0/0) back-to-back for ha_data (fab0/fab1)\n4.  connect net3 (ge-0/0/1) to WAN, intended to be used for reth0\n5.  connect net4 (ge-0/0/2) to LAN\n    \n\nSRX340/SRX345 has dedicated OOB/fxp0 ports VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N\n\n1.  connect ge-0/0/0 to WAN to reach Mist\n2.  connect ge-0/0/1 back-to-back for ha_control\n3.  connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used\n4.  connect ge-0/0/3- to LAN or additional WANs\n    \n\n#### SRX550\n\nge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity\n\n1.  connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)\n2.  connect ge-0/0/1 back-to-back for ha_control\n3.  connect ge-0/0/2 back-to-back for ha_data (fabric)\n4.  connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)\n5.  connect ge-0/0/4- to LAN or additional WANs\n    \n\n#### SRX1500\n\nSRX1500 has, additionally, dedicated HA Control port\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0)\n3. configure ge-0/0/1,ge-7/0/1 for ha_data\n4. configure ge-0/0/2- for LAN or additional WAN\n5. connect dedicated ha_control back-to-back\n6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7. connect ge-0/0/1 back-to-back for ha_data\n8. connect ge-0/0/2- to LAN or additional WANs\n\n    \n#### SRX1600\n\nSRX1600 has, additionally, two dedicated HA Control port\n\n1. form cluster in UI\n2. configure ge-0/0/0,ge-7/0/0 for WAN (reth0)\n3. configure ge-0/0/1,ge-7/0/1 for ha_data\n4. configure ge-0/0/2- for LAN or additional WAN\n5. connect dedicated both ha_control back-to-back\n6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist\n7. connect ge-0/0/1 back-to-back for ha_data\n8. connect ge-0/0/2- to LAN or additional WANs\n\n\n#### SRX4100\n\nSRX4100 has dedicated ha_control and ha_data (fabric) ports\n\n1.  connect dedicated ha_control back-to-back\n2.  connect dedicated ha_data back-to-back\n3.  connect xe-0/0/0 to WAN to reach Mist\n4.  connect xe-0/0/1- to LAN or additional WANs\n\n\n## Replace a Node in a HA Cluster\nUsually Device Replacement is done by Device Replacement API. For a HA cluster, you can also replace a node by another device in the same site.", "operationId": "createSiteDeviceHaCluster", "tags": ["Sites Devices - WAN Cluster"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wan-cluster/create-site-device-ha-cluster"}}}, "image{image_number}": {"specs": {"delete": {"description": "Delete image from a device", "operationId": "deleteSiteDeviceImage", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/delete-site-device-image"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}, {"in": "path", "name": "image_number", "required": true, "schema": {"type": "integer"}}], "post": {"description": "Attach up to 3 images to a device", "operationId": "addSiteDeviceImage", "tags": ["Sites Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/add-site-device-image"}}}, "iot": {"specs": {"get": {"description": "Returns the current state of each enabled IoT pin configured as an output.", "operationId": "getSiteDeviceIotPort", "tags": ["Sites Devices - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wireless/get-site-device-iot-port"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "put": {"description": "**Note**: For each IoT pin referenced:\n * The pin must be enabled using the Device `iot_config` API\n * The pin must support the output direction", "operationId": "setSiteDeviceIotPort", "tags": ["Sites Devices - Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wireless/set-site-device-iot-port"}}}, "local_port_config": {"specs": {"delete": {"description": "API Calls delete all the existing port config local overrides, and reapply the configured planed at the device level \n(with site / template heritance).", "operationId": "deleteSiteLocalSwitchPortConfig", "tags": ["Sites Devices - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/delete-site-local-switch-port-config"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "put": {"description": "API Calls to add port config local overrides. This can be used by Switch Port Operators or Helpdesk administrators\nto change a Switch Port configuration without having to change the switch configuration.\n\n\nThe local overrides configured for the switchports with `no_local_overwrite`==`true` won't be applied to the switch configuration. \n\n\n> NOTE:\n>\n> When using the API Call, it is required to put send all overrides in the PUT request Payload, even the existing once. \n>\n> The current overrides can be retrieved with the API Call [Get Site Device](/#operations/getSiteDevice). The local overrides will show up separately from the `port_config` in the `local_port_config` so it can be easily identified (and cleared)", "operationId": "updateSiteLocalSwitchPortConfig", "tags": ["Sites Devices - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/update-site-local-switch-port-config"}}}, "locate": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "### Access Points\nLocate an Access Point by blinking it's LED.\nIt is a persisted state that has to be stopped by calling Stop Locating API\n\n### Switches\nLocate a Switch by blinking all port LEDs. \nBy default, request is sent to `master` switch and LEDs will keep flashing for 5 minutes.\nIn case of virtual chassis (VC) the desired member mac has to be passed in the request payload. \nAt anypoint, only one VC member can be requested to flash the LED. \nTo stop LED flashing before the duration ends /unlocate API request can be made. \nIf /unlocate API is not called LED will continue to flash on device for the given duration. \nDefault duration is 5 minutes and 120 minutes is the maximum.", "operationId": "startSiteLocateDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/start-site-locate-device"}}}, "monitor_traffic": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Monitor traffic on switches and SRX.\n  * JUNOS uses cmd \"monitor interface <port>\" to monitor traffic on particular <port>\n  * JUNOS uses cmd \"monitor interface traffic\" to monitor traffic on all ports", "operationId": "monitorSiteDeviceTraffic", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/monitor-site-device-traffic"}}}, "ping": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Ping from AP, Switch and SSR\n\nPing can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\",\n    \"data\": {\n        \"session\": \"session_id\",\n        \"raw\": \"64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\\n\"\n    }\n}\n```", "operationId": "pingFromDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/ping-from-device"}}}, "poll_stats": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "This API can be used to poll statistics from the Switch proactively once. After it is called, the statistics will be pushed back to the cloud within the statistics interval.", "operationId": "pollSiteSwitchStats", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/poll-site-switch-stats"}}}, "readopt": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "For the octerm devices, the device ID must come from fpc0. However, for a VC, the users may change the original fpc0 from CLI. To fix the issue, the readopt API could be used to trigger the readopt process so the device would get the corret device ID to connect the cloud.", "operationId": "readoptSiteOctermDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/readopt-site-octerm-device"}}}, "release_dhcp": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Releases an active DHCP lease.\n\nThe output will be available through websocket. As there can be multiple command issued  against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}```\n\n\n\n#### Example output from ws stream\n\n```json\n{  \n  \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd\",\n  \"event\": \"data\",\n  \"data\": {\n    \"session\": \"9106e908-74dc-4a4f-9050-9c2adcaf44a5\",\n    \"raw\": \"Running traceroute...\\ntraceroute to 8.8.8.8, 64 hops max\\n 0  192.168.1.1 1 ms  192.168.1.1 1 ms  192.168.1.1 1 ms\\n 1  80.10.236.81 2 ms  80.10.236.81 4 ms  80.10.236.81 2 ms\\n 2  193.253.80.250 3 ms  193.253.80.250 2 ms  193.253.80.250 2 ms\\n 3  193.252.159.41 2 ms  193.252.159.41 1 ms  193.252.159.41 3 ms\\n\"\n  }\n}\n```\n\"", "operationId": "releaseSiteSsrDhcpLease", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/release-site-ssr-dhcp-lease"}}}, "release_dhcp_leases": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Releases an active DHCP lease.", "operationId": "releaseSiteDeviceDhcpLease", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/release-site-device-dhcp-lease"}}}, "reprovision": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "To force one device to reprovision itself again.", "operationId": "reprovisionSiteOctermDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/reprovision-site-octerm-device"}}}, "request_ztp_password": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "In the case where soemthing happens during/after ZTP, the root-password is modified (required for ZTP to set up outbound-ssh) but the user-defined password config has not be configured. This API can be used to retrieve the temporary password.", "operationId": "getSiteDeviceZtpPassword", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/get-site-device-ztp-password"}}}, "resolve_dns": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "DNS resolutions are performed on the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same SSR at the same time and the output all goes through the same websocket stream, `session` is used for demux.\n \n #### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\n Router      | Hostname               | Resolved | Last Resolved        | Expiration\n-------------|------------------------|----------|----------------------|---------------------\n test-device | xxx.yyy.net            | Y        | 2022-03-28T03:56:49Z | 2022-03-28T03:57:49Z\n```", "operationId": "testSiteSsrDnsResolution", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/test-site-ssr-dns-resolution"}}}, "restart": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Restart / Reboot a device", "operationId": "restartSiteDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/restart-site-device"}}}, "run_top": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Run top command on switches and SRX. The output will be available through websocket. \n\nAs there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```", "operationId": "runSiteSrxTopCommand", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/run-site-srx-top-command"}}}, "service_ping": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Ping from SSR\n\nService Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd\",\n    \"data\": {\n        \"session\": \"session_id\",\n        \"raw\": \"64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\\n\"\n    }\n}\n```", "operationId": "servicePingFromSsr", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/service-ping-from-ssr"}}}, "shell": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Create Shell Session", "operationId": "createSiteDeviceShellSession", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/create-site-device-shell-session"}}}, "show_arp": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get ARP Table from the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n", "operationId": "showSiteDeviceArpTable", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-arp-table"}}}, "show_bgp_rummary": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get BGP Summary from SSR, SRX and Switch.\n\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n\n}\n```\n\n##### Example output from ws stream\n```\nTue 2024-04-23 16:36:06 UTC\nRetrieving bgp entries...\nBGP table version is 354, local router ID is 10.224.8.16, vrf id 0\nDefault local pref 100, local AS 65000\nStatus codes:  s suppressed, d damped, h history, * valid, > best, = multipath,\n              i internal, r RIB_failure, S Stale, R Removed\nNexthop codes: @NNN nexthop's vrf id, < announce-nh-self\nOrigin codes:  i - IGP, e - EGP, ? - incomplete\nRPKI validation codes: V valid, I invalid, N Not found\n\n  Network                                      Next Hop                                  Metric LocPrf Weight Path\n*> 161.161.161.0/24\n```\"", "operationId": "showSiteDeviceBgpSummary", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-bgp-summary"}}}, "show_dhcp_leases": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Shows DHCP leases", "operationId": "showSiteDeviceDhcpLeases", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-dhcp-leases"}}}, "show_evpn_database": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get EVPN Database from the Device. The output will be available through websocket.", "operationId": "showSiteDeviceEvpnDatabase", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-evpn-database"}}}, "show_forwarding_table": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get forwarding table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n##### Example output from ws stream\n```\nMon 2024-05-20 16:47:30 UTC Retrieving fib entries\u2026 Entry Count: 3268 Capacity:    22668 ==================== ====== ======= ================== ===== ====================== =========== =========== ====== IP Prefix            Port   Proto   Tenant             VRF   Service                Next Hops   Vector      Cost ==================== ====== ======= ================== ===== ====================== =========== =========== ====== 0.0.0.0/0               0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 3.1.1.0/24              0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10 branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1 1-4.0       lte           10\n\n```\n", "operationId": "showSiteDeviceForwardingTable", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-forwarding-table"}}}, "show_mac_table": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get MAC Table from the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n", "operationId": "showSiteDeviceMacTable", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/show-site-device-mac-table"}}}, "show_ospf_database": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get OSPF Database from the Device. The output will be available through websocket. \n\nAs there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== ================ =================== =================\nVrf   Neighbor Router ID   Priority   State   Uptime   Dead Timer Due   Interface Address   Interface State\n===== ==================== ========== ======= ======== ================ =================== =================\n      1.0.0.3                     1   Full       852               38   172.16.3.2          Backup\n      1.0.0.4                     1   Full       811               33   172.16.3.2          DROther\n      1.0.0.3                     1   Full       852               38   172.16.4.2          Backup\n      1.0.0.4                     1   Full       811               34   172.16.4.2          DROther\n```", "operationId": "showSiteSsrOspfDatabase", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-ospf-database"}}}, "show_ospf_interfaces": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get OSPF interfaces from the Device. The output will be available through websocket. \n\nAs there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ================== =================== ============== =============== =========== ========= ===========\nVrf   Device Interface   Network Interface   Interface Up   IP Address      OSPF Type   Area ID   Area Type\n===== ================== =================== ============== =============== =========== ========= ===========\n      net1               g1                          True   172.16.1.2/24   Broadcast   0.0.0.0   default\n      net3               g3                          True   172.16.3.2/24   Broadcast   0.0.0.0   default\n      net4               g4                          True   172.16.4.2/24   Broadcast   0.0.0.4   default\n```", "operationId": "showSiteSsrOspfInterfaces", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-ospf-interfaces"}}}, "show_ospf_neighbors": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get OSPF Neighbors from the Device. The output will be available through websocket. \n\nAs there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== ================ =================== =================\nVrf   Neighbor Router ID   Priority   State   Uptime   Dead Timer Due   Interface Address   Interface State\n===== ==================== ========== ======= ======== ================ =================== =================\n      1.0.0.3                     1   Full       852               38   172.16.3.2          Backup\n      1.0.0.4                     1   Full       811               33   172.16.3.2          DROther\n      1.0.0.3                     1   Full       852               38   172.16.4.2          Backup\n      1.0.0.4                     1   Full       811               34   172.16.4.2          DROther\n```", "operationId": "showSiteSsrOspfNeighbors", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-ospf-neighbors"}}}, "show_ospf_summary": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get OSPF summary from the Device. The output will be available through websocket. \n\nAs there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n  \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== =========== ========== ============= ==================== ========= =========== =============\nVrf   Router ID   ABR Type   ASBR Router   External LSA Count   Area ID   Area Type   Area Border\n                                                                                      Router\n===== =========== ========== ============= ==================== ========= =========== =============\n      1.0.0.2     cisco            False                    0   0.0.0.0\n      1.0.0.2     cisco            False                    0   0.0.0.4   default\n```", "operationId": "showSiteSsrOspfSummary", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-ospf-summary"}}}, "show_route": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get routes from SSR, SRX and Switch. \n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\nadmin@labsystem1.fiedler# show bgp neighbors\nBGP neighbor is 192.168.4.1, remote AS 4200000001, local AS 4200000128, external\nlink\n  BGP version 4, remote router ID 1.1.1.1\n  BGP state = Established, up for 00:27:25\n  Last read 00:00:25, hold time is 90, keepalive interval is 30 seconds\n  Configured hold time is 90, keepalive interval is 30 seconds\n  Neighbor capabilities:\n    4 Byte AS: advertised and received\n    Route refresh: advertised and received(old &amp; new)\n    Address family IPv4 Unicast: advertised and received\n    Graceful Restart Capabilty: advertised and received\n      Remote Restart timer is 120 seconds\n      Address families by peer:\n        none\n        ...\n```", "operationId": "showSiteSsrAndSrxRoutes", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-and-srx-routes"}}}, "show_service_path": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get service path information of the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json { \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" } ```\n#### Example output from ws stream\n```json { \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd\", \"event\": \"data\", \"data\": { \"session\":\"5cb8a6db-d11a-42cd-bed7-19e9f29e637\", \"raw\":\"{\\\"status\\\":\\\"SUCCESS\\\",\\\"finished\\\":true,\\\"rows\\\":[{\\\"service\\\":\\\"management\\\",\\\"type\\\":\\\"service-agent\\\",\\\"network_interface\\\":\\\"ge-0/0/0\\\",\\\"destination\\\":\\\"\\\",\\\"gateway_ip\\\":\\\"192.168.1.1\\\",\\\"vector\\\":\\\"\\\",\\\"cost\\\":0,\\\"rate\\\":0,\\\"state\\\":\\\"Up\\\",\\\"capacity\\\":\\\"0/unlimited\\\",\\\"meetsSLA\\\":\\\"Yes\\\"},{\\\"service\\\":\\\"management\\\",\\\"type\\\":\\\"service-agent\\\",\\\"network_interface\\\":\\\"ge-0/0/1\\\",\\\"destination\\\":\\\"\\\",\\\"gateway_ip\\\":\\\"192.168.0.1\\\",\\\"vector\\\":\\\"\\\",\\\"cost\\\":0,\\\"rate\\\":0,\\\"state\\\":\\\"Up\\\",\\\"capacity\\\":\\\"0/unlimited\\\",\\\"meetsSLA\\\":\\\"Yes\\\"}]}\" } } ```", "operationId": "showSiteSsrServicePath", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-service-path"}}}, "show_session": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Get active sessions passing through the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json { \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" }```\n\n#### Example output from ws stream\n```json { \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd\", \"event\": \"data\", \"data\": { \"session\": \"f517bf29-1141-41ae-a084-17cacb0ccb57\", \"raw\": \"{\\\"status\\\":\\\"SUCCESS\\\",\\\"finished\\\":true,\\\"rows\\\":[{\\\"session_id\\\":\\\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\\\",\\\"direction\\\":\\\"forward\\\",\\\"service\\\":\\\"internet\\\",\\\"tenant\\\":\\\"SRV.PRD-Core\\\",\\\"device_interface\\\":\\\"ge-0/0/3\\\",\\\"network_interface\\\":\\\"ge-0/0/3.100\\\",\\\"protocol\\\":\\\"TCP\\\",\\\"source_ip\\\":\\\"10.3.20.101\\\",\\\"source_port\\\":45733,\\\"destination_ip\\\":\\\"13.38.46.35\\\",\\\"destination_port\\\":443,\\\"nat_ip\\\":\\\"192.168.1.115\\\",\\\"nat_port\\\":45256,\\\"payload_encrypted\\\":false,\\\"timeout\\\":1581,\\\"uptime\\\":319},{\\\"session_id\\\":\\\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\\\",\\\"direction\\\":\\\"reverse\\\",\\\"service\\\":\\\"internet\\\",\\\"tenant\\\":\\\"SRV.PRD-Core\\\",\\\"device_interface\\\":\\\"ge-0/0/0\\\",\\\"network_interface\\\":\\\"ge-0/0/0\\\",\\\"protocol\\\":\\\"TCP\\\",\\\"source_ip\\\":\\\"13.38.46.35\\\",\\\"source_port\\\":443,\\\"destination_ip\\\":\\\"192.168.1.115\\\",\\\"destination_port\\\":45256,\\\"nat_ip\\\":\\\"0.0.0.0\\\",\\\"nat_port\\\":0,\\\"payload_encrypted\\\":false,\\\"timeout\\\":1581,\\\"uptime\\\":319}]}\\n\" } } ```", "operationId": "showSiteSsrAndSrxSessions", "tags": ["Utilities WAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/show-site-ssr-and-srx-sessions"}}}, "snapshot": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)", "operationId": "createSiteDeviceSnapshot", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/create-site-device-snapshot"}}}, "support": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Support / Upload device support files\n\n#### Info Param\n| Name | Type | Description |\n| --- | --- | --- |\n| process | string | Upload 1 file with output of show system processes extensive |\n| outbound-ssh | string | Upload 1 file that concatenates all /var/log/outbound-ssh.log* files |\n| messages | string | Upload 1 to 10 /var/log/messages* files |\n| core-dumps | string | Upload all core dump files, if any |\n| full | string | Upload 1 file with output of request support information, 1 file that concatenates all /var/log/outbound-ssh.log files, all core dump files, the 3 most recent /var/log/messages files, and Mist agent logs (for Junos devices running the Mist agent) |\n| var-logs | string | Upload all non-empty files in the /var/log/ directory |\n| jma-logs | string | Upload Mist agent logs (for Junos devices running the Mist agent only) |\n\"", "operationId": "uploadSiteDeviceSupportFile", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/upload-site-device-support-file"}}}, "synthetic_test": {"specs": {"get": {"description": "Get Device Synthetic Test", "operationId": "getSiteDeviceSyntheticTest", "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/get-site-device-synthetic-test"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Trigger Device Synthetic Test", "operationId": "triggerSiteDeviceSyntheticTest", "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/trigger-site-device-synthetic-test"}}}, "traceroute": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Traceroute can be performed from the Device.\n\nThe output will be available through websocket. As there can be multiple command issued against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}```\n\n\n\n#### Example output from ws stream\n\n```json\n{  \n  \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd\",\n  \"event\": \"data\",\n  \"data\": {\n    \"session\": \"9106e908-74dc-4a4f-9050-9c2adcaf44a5\",\n    \"raw\": \"Running traceroute...\\ntraceroute to 8.8.8.8, 64 hops max\\n 0  192.168.1.1 1 ms  192.168.1.1 1 ms  192.168.1.1 1 ms\\n 1  80.10.236.81 2 ms  80.10.236.81 4 ms  80.10.236.81 2 ms\\n 2  193.253.80.250 3 ms  193.253.80.250 2 ms  193.253.80.250 2 ms\\n 3  193.252.159.41 2 ms  193.252.159.41 1 ms  193.252.159.41 3 ms\\n\"\n  }\n}\n```\n\"", "operationId": "tracerouteFromDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/traceroute-from-device"}}}, "unlocate": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Stop Locate a Device", "operationId": "stopSiteLocateDevice", "tags": ["Utilities Common"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/stop-site-locate-device"}}}, "upgrade": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Device Upgrade", "operationId": "upgradeDevice", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-device"}}}, "upgrade_bios": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Upgrade device bios", "operationId": "upgradeDeviceBios", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/upgrade-device-bios"}}}, "upgrade_fpga": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Upgrade device fpga", "operationId": "upgradeDeviceFPGA", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/upgrade-device-f-p-g-a"}}}, "vc": {"specs": {"delete": {"description": "When all the member switches of VC are removed and only member ID 0 is left, the cloud would detect this situation and automatically changes the single switch to non-VC role.\n\nFor some unexpected cases that the VC is gone and disconncted, the API below could be used to change the state of VC\u2019s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory.", "operationId": "deleteSiteVirtualChassis", "tags": ["Sites Devices - Wired - Virtual Chassis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/virtual-chassis/delete-site-virtual-chassis"}, "get": {"description": "Get VC Status\n\nThe API returns a combined view of the VC status which includes topology and stats_", "operationId": "getSiteDeviceVirtualChassis", "tags": ["Sites Devices - Wired - Virtual Chassis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/virtual-chassis/get-site-device-virtual-chassis"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory.\n\nIn case that the user would like to choose the dedicated switch as a VC master. Or for EX2300-C-12P and EX2300-C-12T which doesn\u2019t have dedicated VC ports, below are procedures to automate the VC creation:\n\n1. Power on the switch that is choosen as the VC master first. And the powering on the other member switches.\n2. Claim or adopt all these switches under the same organization\u2019s Inventory\n3. Assign these switches into the same Site\n4. Invoke vc command on the switch choosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.\n5. Connect the cables to the VC ports for these switches\n6. Wait for the VC to be formed. The Org\u2019s inventory will be updated for the new VC.", "operationId": "createSiteVirtualChassis", "tags": ["Sites Devices - Wired - Virtual Chassis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/virtual-chassis/create-site-virtual-chassis"}, "put": {"description": "The VC creation and adding member switch API will update the device\u2019 s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config.\n\nIn this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change.\n\nNotice: to configure preprovisioned VC, every member of the VC must be in the inventory.\n\n## Add new members\nFor models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory.\n\nFor EX2300 VC, adding new members requires to follow the procedures below:\n1. Powering on the new member switches and ensuring cables are not connected to any VC ports.\n2. Claim or adopt all new member switches under the VC\u2019s organization Inventory\n3. Assign all new member switches to the same Site as the VC\n4. Invoke vc command to add switches to the VC.\n5. Connect the cables to the VC ports for these switches\n6. After a while, the Org\u2019s Inventory shows this new switches has been added into the VC.\n\n## Removing member switch\nTo remove a member switch from the VC, following the procedures below:\n\n1. Ensuring the VC is connected to the cloud first\n2. Unplug the cable from the VC port of the switch\n3. Waiting for the VC state (vc_state) of this switch is changed to not-present\n4. Invoke update_vc with remove to remove this switch from the VC\n5. The Org\u2019s Inventory shows the switch is removed.\n\nPlease notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unpluging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happened, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again.\n\n## Renumber a member switch\nWhen a member switch doesn\u2019 t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported:\n\n1. Replace a non-fpc0 member switch\n2. Replace fpc0. When fpc0 is relaced, PAPI device config and JUNOS config will be both updated.\n\nFor renumber to work, the following procedures are needed: \n1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. \n2. Adding the new member switch to the VC \n3. Waiting for the VC state (vc_state) of this VC to be updated to API server \n4. Invoke vc with renumber to replace the new member switch from fpc X to\n\n## Perprovision VC members\nBy specifying \u201cpreprovision\u201d op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change.\n\nNote: \n1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added \n2. New VC members to be added should exist in the same Site as the VC\n\nUpdate Device\u2019s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.", "operationId": "updateSiteVirtualChassisMember", "tags": ["Sites Devices - Wired - Virtual Chassis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/virtual-chassis/update-site-virtual-chassis-member"}}, "paths": {"vc_port": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Set VC port", "operationId": "setSiteVcPort", "tags": ["Sites Devices - Wired - Virtual Chassis"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/wired/virtual-chassis/set-site-vc-port"}}}}}}}}}, "events": {"paths": {"fast_roam": {"specs": {"get": {"description": "Get Roaming Events data", "operationId": "getSiteRoamingEvents", "parameters": [{"description": "event type", "in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/fast_roam_result"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/events/get-site-roaming-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "system": {"paths": {"count": {"specs": {"get": {"description": "Count System Events", "operationId": "countSiteSystemEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_system_events_count_distinct"}}, {"$ref": "#/components/parameters/system_event_type"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/events/count-site-system-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search System Events", "operationId": "searchSiteSystemEvents", "parameters": [{"$ref": "#/components/parameters/system_event_type"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Events"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/events/search-site-system-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}}}, "evpn_topologies": {"specs": {"get": {"description": "Get the existing EVPN topology", "operationId": "listSiteEvpnTopologies", "tags": ["Sites EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/evpn-topologies/list-site-evpn-topologies"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "While all the `evpn_id` / `downlink_ips` can be specifidd by hand, the easiest way is to call the `build_vpn_topology` API, allowing you to examine the diff, and update it yourself. You can also simply call it with `overwrite=true` which will apply the updates for you.\n\n**Notes:**\n1. You can use `core` / `distribution` / `access` to create a CLOS topology\n2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches\n3. In a small/medium campus, `collapsed-core` can be used where core switches are the inter-connected to do EVPN\n4. The API uses a few pre-defined parameters and best-practices to generate the configs. It can be customized by using `evpn_options` in Site Setting / Network Template. (e.g. a different subnet for the underlay)\n\n#### Collapsed Core\nIn a small-medium campus, EVPN can also be enabled only at the core switches (up to 4) by assigning all participating switches with `collapsed-core role`. When there are more than 2 switches, a ring-like topology will be formed.\n\n#### ESI-Lag\nIf the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches\n\n#### Leaf / Access / Collapsed-Core\nFor leaf nodes in a EVPN topology, you\u2019d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another", "operationId": "createSiteEvpnTopology", "tags": ["Sites EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/evpn-topologies/create-site-evpn-topology"}}, "paths": {"{evpn_topology_id}": {"specs": {"delete": {"description": "Delete the site EVPN Topology", "operationId": "deleteSiteEvpnTopology", "tags": ["Sites EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/evpn-topologies/delete-site-evpn-topology"}, "get": {"description": "Get One EVPN Topology Detail", "operationId": "getSiteEvpnTopology", "tags": ["Sites EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/evpn-topologies/get-site-evpn-topology"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/evpn_topology_id"}], "put": {"description": "Update the EVPN Topolgy", "operationId": "updateSiteEvpnTopology", "tags": ["Sites EVPN Topologies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/evpn-topologies/update-site-evpn-topology"}}}}}, "gatewaytemplates": {"paths": {"derived": {"specs": {"get": {"description": "Get derived Gateway Templates for Site", "operationId": "listSiteGatewayTemplateDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites Gateway Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/gateway-templates/list-site-gateway-template-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "guests": {"specs": {"get": {"description": "Get List of Site Guest Authorizations", "operationId": "listSiteAllGuestAuthorizations", "parameters": [{"description": "UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}], "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/list-site-all-guest-authorizations"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"count": {"specs": {"get": {"description": "Count Authorized Guest", "operationId": "countSiteGuestAuthorizations", "parameters": [{"example": "auth_method", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_guests_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/count-site-guest-authorizations"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "derived": {"specs": {"get": {"description": "Get List of Site Guest Authorizations", "operationId": "listSiteAllGuestAuthorizationsDerived", "parameters": [{"description": "UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"description": "whether to get org level guests, default is false i.e get site level guests", "in": "query", "name": "cross_site", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/list-site-all-guest-authorizations-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Authorized Guest", "operationId": "searchSiteGuestAuthorization", "parameters": [{"example": "00000000-0000-0000-0000-000000000000", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}, {"in": "query", "name": "auth_method", "schema": {"type": "string"}}, {"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/search-site-guest-authorization"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{guest_mac}": {"specs": {"delete": {"description": "Delete Guest Authorization", "operationId": "deleteSiteGuestAuthorization", "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/delete-site-guest-authorization"}, "get": {"description": "Get Guest Authorization", "operationId": "getSiteGuestAuthorization", "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/get-site-guest-authorization"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/guest_mac"}], "put": {"description": "Update Guest Authorization", "operationId": "updateSiteGuestAuthorization", "tags": ["Sites Guests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/guests/update-site-guest-authorization"}}}}}, "insights": {"paths": {"client": {"paths": {"{client_mac}": {"paths": {"{metric}": {"specs": {"get": {"description": "Get Client Insight Metrics\nSee metrics possibilities at /api/v1/const/insight_metrics", "operationId": "getSiteInsightMetricsForClient", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Insights"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/insights/get-site-insight-metrics-for-client"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}, {"$ref": "#/components/parameters/metric"}]}}}}}}, "device": {"paths": {"{device_mac}": {"paths": {"{metric}": {"specs": {"get": {"description": "Get AP Insight Metrics\nSee metrics possibilities at /api/v1/const/insight_metrics", "operationId": "getSiteInsightMetricsForDevice", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Insights"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/insights/get-site-insight-metrics-for-device"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/metric"}, {"$ref": "#/components/parameters/device_mac"}]}}}}}}, "rogues": {"specs": {"get": {"description": "Get List of Site Rogue/Neighbor APs", "operationId": "listSiteRogueAPs", "parameters": [{"$ref": "#/components/parameters/rogue_type"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}], "tags": ["Sites Rogues"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rogues/list-site-rogue-a-ps"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"clients": {"specs": {"get": {"description": "Get List of Site Rogue Clients", "operationId": "listSiteRogueClients", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}], "tags": ["Sites Rogues"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rogues/list-site-rogue-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "{metric}": {"specs": {"get": {"description": "Get Site Insight Metrics\nSee metrics possibilities at /api/v1/const/insight_metrics", "operationId": "getSiteInsightMetrics", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/interval"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Insights"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/insights/get-site-insight-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/metric"}]}}}}, "licenses": {"paths": {"usages": {"specs": {"get": {"description": "This shows license usage (i.e. needed) based on the features enabled for the site.", "operationId": "getSiteLicenseUsage", "tags": ["Sites Licenses"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/licenses/get-site-license-usage"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "location": {"paths": {"coverage": {"specs": {"get": {"description": "Get Beam Coverage Overview", "operationId": "getSiteBeamCoverageOverview", "parameters": [{"description": "map_id (filter by map_id)", "example": "00000000-0000-0000-0000-000000000000", "in": "query", "name": "map_id", "schema": {"type": "string"}}, {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/rf_client_type"}}, {"description": "client_type (as filter. optional)", "in": "query", "name": "client_type", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/resolution"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}], "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/get-site-beam-coverage-overview"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "ml": {"paths": {"current": {"specs": {"get": {"description": "Get Machine Learning Current Stat\nFor each VBLE AP, it has ML model parameters (e.g. Path-loss-estimate, Intercept) as well as completion indicators (Level and PercentageComplete). For the completeness, ML takes N sample to finish its first level and use N*0.25 samples to complete each successive level. When a device is moved, the completeness will be reset as it has to re-learn.", "operationId": "getSiteMachineLearningCurrentStat", "parameters": [{"description": "map_id (as filter, optional)", "example": "00000000-0000-0000-0000-000000000000", "in": "query", "name": "map_id", "schema": {"type": "string"}}], "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/get-site-machine-learning-current-stat"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "defaults": {"specs": {"get": {"description": "Get Default PLF for Models", "operationId": "getSiteDefaultPlfForModels", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/get-site-default-plf-for-models"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "device": {"paths": {"{device_id}": {"specs": {"delete": {"description": "Clear ML Overwrite for Device", "operationId": "clearSiteMlOverwriteForDevice", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/clear-site-ml-overwrite-for-device"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "put": {"description": "Overwrite ML For Device", "operationId": "overwriteSiteMlForDevice", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/overwrite-site-ml-for-device"}}}}}, "map": {"paths": {"{map_id}": {"specs": {"delete": {"description": "Clear ML Overwrite for Map", "operationId": "clearSiteMlOverwriteForMap", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/clear-site-ml-overwrite-for-map"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "put": {"description": "Overwrite ML For Map", "operationId": "overwriteSiteMlForMap", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/overwrite-site-ml-for-map"}}}}}, "reset": {"paths": {"map": {"paths": {"{map_id}": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "Reset ML Stats by Map", "operationId": "resetSiteMlStatsByMap", "tags": ["Sites Location"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/location/reset-site-ml-stats-by-map"}}}}}}}}}}}, "maps": {"specs": {"get": {"description": "Get List of Site Maps", "operationId": "listSiteMaps", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/list-site-maps"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site Map", "operationId": "createSiteMap", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/create-site-map"}}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches.\n\n# Note\nThis endpoint (at the site level), the AP must be already assigned to the site to be placed on the floorplan. If you want to place APs from the Org inventory, it is required to use the endpoint at the Org level [importOrgMaps](#operation/importOrgMaps)\n\n# CSV File Format\n```csv\nVendor AP name,Mist AP Mac\nUS Office AP-2,5c:5b:35:00:00:02\nUS Office AP-3,5c5b35000002\n```", "operationId": "importSiteMaps", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/import-site-maps"}}}, "{map_id}": {"specs": {"delete": {"description": "Delete Site Map", "operationId": "deleteSiteMap", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/delete-site-map"}, "get": {"description": "Get Site Map Details", "operationId": "getSiteMap", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/get-site-map"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "put": {"description": "Update Site Map", "operationId": "updateSiteMap", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/update-site-map"}}, "paths": {"auto_orient": {"specs": {"delete": {"description": "This API is called to force stop auto placement for a given map", "operationId": "deleteSiteApAutoOrientation", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/delete-site-ap-auto-orientation"}, "parameters": [{"$ref": "#/components/parameters/map_id"}, {"$ref": "#/components/parameters/site_id"}], "post": {"description": "This API is called to trigger a map for auto orientation. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST to this endpoint while a map is still running will be rejected.\n\nList of devices to provide suggestions for is an optional parameter that can be given to this API. This will provide auto orient suggestions only for the devices specified. If no list of devices is provided, all APs asociated with that map are considered by default", "operationId": "startSiteApAutoOrientation", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/start-site-ap-auto-orientation"}}}, "auto_placement": {"specs": {"delete": {"description": "This API is called to force stop auto placement for a given map", "operationId": "deleteSiteApAutoplacement", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/delete-site-ap-autoplacement"}, "get": {"description": "This API is called to view the current status of auto placement for a given map.\n\n\n#### Status Descriptions\n\n| Status | Description |\n| --- | --- |\n| `pending` | Autoplacement has not been requested for this map |\n| `inprogress` | Autoplacement is currently processing |\n| `done` | The autoplacement process has completed |\n| `data_needed` | Additional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map |\n| `invalid_model` | Autoplacement is not supported on the model of the APs on the map |\n| `invalid_version` | Autoplacement is not supported with the APs current firmware version |\n| `error` | There was an error in the autoplacement process |", "operationId": "getSiteApAutoPlacement", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/get-site-ap-auto-placement"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This API is called to trigger a map for auto placement. For auto placement feature to work, RTT-FTM data need to be collected from the APs on the map. This scan is disruptive and therefore the user must be notified of service disrution during the functioning of auto placement Repeated POST to this endpoint while a map is still running will be rejected.\n\nList of devices to provide suggestions for is an optional parameter that can be given to this API. This will provide autoplacement suggestions only for the devices specified. If no list of devices is provided, all APs asociated with that map are considered by default", "operationId": "runSiteApAutoplacement", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/run-site-ap-autoplacement"}}}, "auto_zones": {"specs": {"delete": {"description": "This API is called to cancel auto zones for a given map and to delete the suggested zones returned by the service. If the service was not it will still delete any suggested zones and clear the auto zones service status.", "operationId": "deleteSiteMapAutoZone", "tags": ["Sites Maps - Auto-Zone"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-zone/delete-site-map-auto-zone"}, "get": {"description": "This API provides the current status of the auto zones service for a given map", "operationId": "getSiteMapAutoZoneStatus", "tags": ["Sites Maps - Auto-Zone"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-zone/get-site-map-auto-zone-status"}, "parameters": [{"$ref": "#/components/parameters/map_id"}, {"$ref": "#/components/parameters/site_id"}], "post": {"description": "This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Reppeated POST requests to this endpoint while the auto zones service is proccessing the map will be rejected.", "operationId": "startSiteMapAutoZone", "tags": ["Sites Maps - Auto-Zone"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-zone/start-site-map-auto-zone"}}}, "clear_auto_orient": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This API is used to destroy the autoorientations of a map or subset of APs on a map.", "operationId": "clearSiteApAutoOrient", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/clear-site-ap-auto-orient"}}}, "clear_autoplacement": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This API is used to destroy the cached autoplacement locations of a map or subset of APs on a map.", "operationId": "clearSiteApAutoplacement", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/clear-site-ap-autoplacement"}}}, "image": {"specs": {"delete": {"description": "Delete Site Map Image", "operationId": "deleteSiteMapImage", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/delete-site-map-image"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "Add image map is a multipart POST which has an file (Image) and an optional json parameter", "operationId": "addSiteMapImage", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/add-site-map-image"}}}, "replace": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "Replace Map Image\n\n\nThis works like an PUT where the image will be replaced. If transform is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)", "operationId": "replaceSiteMapImage", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/replace-site-map-image"}}}, "set_map": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This API can be used to assign a list of AP Macs associated with site_id to the specified map_id. Note that map_id must be associated with corresponding site_id. This API obeys the following rules \n1. if AP is unassigned to any Map, it gets associated with map_id \n2. Any moved APs are returned in the response \n3. If the AP is considered a locked AP, no action will be taken", "operationId": "bulkAssignSiteApsToMap", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/bulk-assign-site-aps-to-map"}}}, "use_auto_ap_values": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This API is used to accept or reject the cached autoplacement and auto orientation values of a map or subset of APs on a map. A rejected AP will retain its current X,Y and orientation until accpeted.", "operationId": "confirmSiteApLocalizationData", "tags": ["Sites Maps - Auto-placement"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/auto-placement/confirm-site-ap-localization-data"}}}, "wayfinding": {"paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}], "post": {"description": "This imports the vendor map meta data into the Map JSON. This is required by the SDK and App in order to access/render the vendor Map properly.", "operationId": "importSiteWayfindings", "tags": ["Sites Maps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/maps/import-site-wayfindings"}}}}}}}}}, "mxedges": {"specs": {"get": {"description": "Get List of Site Mist Edges", "operationId": "listSiteMxEdges", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/list-site-mx-edges"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Mist Edge Events", "operationId": "countSiteMxEdgeEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_mxedge_events_count_distinct"}}, {"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/mxedge_event_type"}, {"description": "service running on mist edge(mxagent, tunterm etc)", "in": "query", "name": "service", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/count-site-mx-edge-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Site Mist Edge Events", "operationId": "searchSiteMistEdgeEvents", "parameters": [{"description": "mist edge id", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "mist edge cluster id", "in": "query", "name": "mxcluster_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/mxedge_event_type"}, {"description": "service running on mist edge(mxagent, tunterm etc)", "in": "query", "name": "service", "schema": {"type": "string"}}, {"description": "component like PS1, PS2", "in": "query", "name": "component", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/search-site-mist-edge-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "{mxedge_id}": {"specs": {"delete": {"description": "Delete Site Mist Edge", "operationId": "deleteSiteMxEdge", "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/delete-site-mx-edge"}, "get": {"description": "get Site Mist Edge", "operationId": "getSiteMxEdge", "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/get-site-mx-edge"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "put": {"description": "Update Site Mist Edge settings", "operationId": "updateSiteMxEdge", "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/update-site-mx-edge"}}, "paths": {"support": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/mxedge_id"}], "post": {"description": "Support / Upload Mist Edge support files", "operationId": "uploadSiteMxEdgeSupportFiles", "tags": ["Sites MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/mxedges/upload-site-mx-edge-support-files"}}}}}}}, "mxtunnels": {"paths": {"{mxtunnel_id}": {"paths": {"preempt_aps": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/mxtunnel_id"}], "post": {"description": "To preempt AP\u2019s which are not connected to preferred peer to the preferred peer", "operationId": "preemptSitesMxTunnel", "tags": ["Utilities MxEdge"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/mxedge/preempt-sites-mx-tunnel"}}}}}}}, "nac_clients": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of NAC Clients", "operationId": "countSiteNacClients", "parameters": [{"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_nac_clients_count_distinct"}}, {"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "last_nacrule_id", "schema": {"type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan ID", "in": "query", "name": "last_vlan_id", "schema": {"type": "string"}}, {"description": "vendor of NAS device", "in": "query", "name": "last_nas_vendor", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "last_ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "last_username", "schema": {"type": "string"}}, {"description": "start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "AP MAC connected to by client", "in": "query", "name": "last_ap", "schema": {"type": "string"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Connection status of client i.e \u201cpermitted\u201d, \u201cdenied, \u201csession_ended\u201d", "in": "query", "name": "last_status", "schema": {"type": "string"}}, {"description": "Client type i.e. \u201cwireless\u201d, \u201cwired\u201d etc.", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "MDM compliancy of client i.e \u201ccompliant\u201d, \u201cnot compliant\u201d", "in": "query", "name": "mdm_compliance_status", "schema": {"type": "string"}}, {"description": "MDM provider of client\u2019s organisation eg \u201cintune\u201d, \u201cjamf\u201d", "in": "query", "name": "mdm_provider", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/nac/count-site-nac-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of NAC Client-Events", "operationId": "countSiteNacClientEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_nac_client_events_count_distinct"}}, {"$ref": "#/components/parameters/nac_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/nac/count-site-nac-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search NAC Client Events", "operationId": "searchSiteNacClientEvents", "parameters": [{"$ref": "#/components/parameters/nac_event_type"}, {"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "nacrule_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "NAC Policy Dry Run Rule ID, if present and matched", "in": "query", "name": "dryrun_nacrule_id", "schema": {"type": "string"}}, {"description": "True - if dryrun rule present and matched with priority, False - if not matched or not present", "in": "query", "name": "dryrun_nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan ID", "in": "query", "name": "vlan", "schema": {"type": "integer"}}, {"description": "vendor of NAS device", "in": "query", "name": "nas_vendor", "schema": {"type": "string"}}, {"description": "BSSID", "in": "query", "name": "bssid", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"format": "uuid", "type": "string"}}, {"description": "IDP returned roles/groups for the user", "in": "query", "name": "idp_role", "schema": {"type": "string"}}, {"description": "Username presented to the Identity Provider", "in": "query", "name": "idp_username", "schema": {"type": "string"}}, {"description": "Radius attributes returned by NAC to NAS Devive", "in": "query", "name": "resp_attrs", "schema": {"$ref": "#/components/schemas/strings"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "username", "schema": {"type": "string"}}, {"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "AP random macMAC", "in": "query", "name": "random_mac", "schema": {"type": "boolean"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "labels derived from usermac entry", "in": "query", "name": "usermac_label", "schema": {"type": "string"}}, {"description": "partial / full MAC address, username, device_mac or ap", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "IP address of NAS device", "in": "query", "name": "nas_ip", "schema": {"type": "string"}}, {"description": "sort options, \u2018-\u2018 prefix represents DESC order, default is wcid in ASC order", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "vendor specific Vlan ID in radius requests", "in": "query", "name": "ingress_vlan", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/nac/search-site-nac-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Site NAC Clients", "operationId": "searchSiteNacClients", "parameters": [{"description": "NAC Policy Rule ID, if matched", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"description": "NAC Policy Rule Matched", "in": "query", "name": "nacrule_matched", "schema": {"type": "boolean"}}, {"description": "authentication type, e.g. \"eap-tls\", \"peap-tls\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"", "in": "query", "name": "auth_type", "schema": {"type": "string"}}, {"description": "Vlan name or ID assigned to the client", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"description": "vendor of NAS device", "in": "query", "name": "nas_vendor", "schema": {"type": "string"}}, {"description": "SSO ID, if present and used", "in": "query", "name": "idp_id", "schema": {"type": "string"}}, {"description": "SSID", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "Username presented by the client", "in": "query", "name": "username", "schema": {"type": "string"}}, {"description": "start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "AP MAC connected to by client", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "ID of Mist Edge that the client is connected through", "in": "query", "name": "mxedge_id", "schema": {"type": "string"}}, {"description": "NAC Policy Rule Name matched", "in": "query", "name": "nacrule_name", "schema": {"type": "string"}}, {"description": "Connection status of client i.e \u201cpermitted\u201d, \u201cdenied, \u201csession_ended\u201d", "in": "query", "name": "status", "schema": {"type": "string"}}, {"description": "Client type i.e. \u201cwireless\u201d, \u201cwired\u201d etc.", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "MDM compliancy of client i.e \u201ccompliant\u201d, \u201cnot compliant\u201d", "in": "query", "name": "mdm_compliance", "schema": {"type": "string"}}, {"description": "MDM provider of client\u2019s organisation eg \u201cintune\u201d, \u201cjamf\u201d", "in": "query", "name": "mdm_provider", "schema": {"type": "string"}}, {"description": "sort options, \u2018-\u2018 prefix represents DESC order, default is wcid in ASC order", "in": "query", "name": "sort", "schema": {"type": "string"}}, {"description": "vendor specific Vlan ID in radius requests", "in": "query", "name": "ingress_vlan", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - NAC"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/nac/search-site-nac-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "networks": {"paths": {"derived": {"specs": {"get": {"description": "Retrieves the list of Networks available for the Site", "operationId": "listSiteNetworksDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Networks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/networks/list-site-networks-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "networktemplates": {"paths": {"derived": {"specs": {"get": {"description": "Get derived Network Templates for Site", "operationId": "listSiteNetworkTemplateDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites Network Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/network-templates/list-site-network-template-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "otherdevices": {"specs": {"get": {"description": "Get List of Site other devices (3rd party devices)", "operationId": "listSiteOtherDevices", "parameters": [{"in": "query", "name": "vendor", "schema": {"type": "string"}}, {"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "serial", "schema": {"type": "string"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "name", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/others/list-site-other-devices"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Site OtherDevices Events", "operationId": "countSiteOtherDeviceEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_other_device_events_count_distinct"}}, {"$ref": "#/components/parameters/otherdevice_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/others/count-site-other-device-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Site OtherDevices Events", "operationId": "searchSiteOtherDeviceEvents", "parameters": [{"description": "mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "mac of attached device", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "vendor name", "in": "query", "name": "vendor", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/otherdevice_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Devices - Others"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/devices/others/search-site-other-device-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}}}, "pcaps": {"specs": {"get": {"description": "Get List of Site Packet Captures", "operationId": "listSitePacketCaptures", "parameters": [{"description": "optional client mac filter", "in": "query", "name": "client_mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/list-site-packet-captures"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"capture": {"specs": {"delete": {"description": "Stop current capture", "operationId": "stopSitePacketCapture", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/stop-site-packet-capture"}, "get": {"description": "Get Capturing status", "operationId": "getSiteCapturingStatus", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/get-site-capturing-status"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Initiate a Site Packet Capture\n\nThe output will be available through websocket. As there can be multiple command issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/pcaps\"\n}\n```\n#### Response (MxEdge)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/:site_id/pcaps\"\n    \"data\": {\n         \"capture_id\": \"6b1be4fb-b239-44d9-9d3b-cb1ff3af1721\",\n     \"lost_messages\": 0\n         \"pcap_dict\": {\n             \"channel_frequency\": 2412,\n             \"channel\": \"1\",\n             \"datarate\": \"1.0 Mbps\",\n             \"rssi\": -75, \n             \"dst\": \"78:bd:bc:ca:0b:0a\",\n             \"src\": \"18:b8:1f:4c:91:c0\",\n             \"bssid\": \"18:b8:1f:4c:91:c0\",\n             \"frame_type\": \"Management\", \n             \"frame_subtype\": \"Probe Response\", \n         \"proto\": \"802.11\", \n             \"ap_mac\": \"d4:20:b0:81:99:2e\", \n             \"direction\": \"tx\", \n             \"timestamp\": 1652246543, \n             \"length\": 416.0,\n             \"interface\": \"radiotap\",\n             \"info\": \"1652246544.467733 1683216786us tsft 1.0 Mb/s 2412 MHz 11g -75dBm signal -82dBm noise antenna 0 Probe Response (ATTKmsWiVS) [1.0* 2.0* 5.5* 11.0* 18.0 24.0 36.0 54.0 Mbit] CH: 2, PRIVACY\\\\n\",\n         }, \n        \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAEEh7Yh5VBwCgAQAAoAEAAAAAKwBvCADAAQAAAIw7reCS2VNkAAAAABACbAmABLWuAAEAEBgAAwACAABQADoBeL28ygsKGLgfTJHAGLgfTJHAcIZ2WDlBJQAAAGQAERUACkFUVEttc1dpVlMBCIKEi5YkMEhsAwECBwZVUyABCx4gAQAjAhkAKgEEMgQMEhhgMBQBAAAPrAQBAAAPrAQBAAAPrAIMAAsFAQAbAABGBTIIAQAALRqtCR////8AAAAAAAAAAAAAAAAAAAAAAAAAAD0WAggVAAAAAAAAAAAAAAAAAAAAAAAAAH8IBAAIAAAAAEDdkwBQ8gQQSgABEBBEAAECEDsAAQMQRwAQn2481frn3KT+uGod2ERx+RAhAAtBcnJpcywgSW5jLhAjAApCR1cyMTAtNzAwECQACkJHVzIxMC03MDAQQgAKQkdXMjEwLTcwMBBUAAgABgBQ8gQAARARAA5BcnJpcyBXaXJlbGVzcxAIAAIgCBA8AAEBEEkABgA3KgABIN0JABAYAgEQHAAA3RgAUPICAQGEAAOkAAAnpAAAQkNeAGIyLwAzjakr\"\n}\n```\n\n#### Response (Wired)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n    \"data\": {\n        \"capture_id\": \"f039b1b4-a23e-48b2-906a-0da40524de73\", \n        \"pcap_dict\": {\n             \"dst_mac\": \"68:ec:c5:09:2e:87\",\n             \"src_mac\": \"8c:3b:ad:e0:47:40\", \n             \"vlan\": 1, \n             \"src_ip\": \"34.224.147.117\", \n             \"dst_ip\": \"192.168.1.55\",\n             \"dst_port\": 51635, \n             \"src_port\": 443,\n             \"proto\": \"TCP\", \n             \"ap_mac\": \"d4:20:b0:81:99:2e\",\n             \"direction\": \"tx\", \n             \"timestamp\": 1652247615, \n             \"length\": 159.0, \n             \"interface\": \"wired\",\n             \"info\": \"1652247616.007409 IP ec2-34-224-147-117.compute-1.amazonaws.com.https > ip-192-168-1-55.ec2.internal.51635: Flags [P.], seq 2192123968:2192124057, ack 4035166782, win 12, options [nop,nop,TS val 597467050 ecr 740580660], length 89\\\\n\",\n             }, \n        \"pcap_raw\": \"1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA==\"\n\n    }\n}\n```\n\n#### Stop Response (Wired/Wireless)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps\"\n    \"data\": {\n      \"capture_id\": \"a2f7374d-6a70-41fd-8a3f-71e42573baaf\", \n      \"lost_messages\": 0,\n      \"pcap_dict\": null\n    }\n}\n```", "operationId": "startSitePacketCapture", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/start-site-packet-capture"}}}, "{pcap_id}": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/pcap_id"}], "put": {"description": "Update or add notes to a completed packet capture", "operationId": "updateSitePacketCapture", "tags": ["Utilities PCAPs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/pcaps/update-site-packet-capture"}}}}}, "psks": {"specs": {"get": {"description": "Get List of Site PSKs", "operationId": "listSitePsks", "parameters": [{"in": "query", "name": "ssid", "schema": {"type": "string"}}, {"in": "query", "name": "role", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/name"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/list-site-psks"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site PSK\n\n\nWhen `usage`==`macs`, corresponding \"macs\" field will hold a list consisting of client mac addresses ([\"xx:xx:xx:xx:xx\",...]) or mac patterns([\"xx:xx:*\",\"xx*\",...]) or both ([\"xx:xx:xx:xx:xx:xx\", \"xx:*\", ...]). This list is capped at 5000", "operationId": "createSitePsk", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/create-site-psk"}, "put": {"description": "Update multiple PSKs", "operationId": "updateSiteMultiplePsks", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/update-site-multiple-psks"}}, "paths": {"import": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Import PSK from CSV file or JSON\n\n## CSV File Format\n```csv\nPSK Import CSV File Format:\nname,ssid,passphrase,usage,vlan_id,mac\nCommon,warehouse,foryoureyesonly,single,35,a31425f31278\nJustin,reception,visible,multi,1002\n```", "operationId": "importSitePsks", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/import-site-psks"}}}, "{psk_id}": {"specs": {"delete": {"description": "Delete Site PSK", "operationId": "deleteSitePsk", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/delete-site-psk"}, "get": {"description": "Get Site PSK Details", "operationId": "getSitePsk", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/get-site-psk"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/psk_id"}], "put": {"description": "Update Site PSK", "operationId": "updateSitePsk", "tags": ["Sites Psks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/psks/update-site-psk"}}}}}, "rfdiags": {"specs": {"get": {"description": "List RF Glass Recording", "operationId": "getSiteSiteRfdiagRecording", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/get-site-site-rfdiag-recording"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Start RF Glass Recording", "operationId": "startSiteRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/start-site-recording"}}, "paths": {"{rfdiag_id}": {"specs": {"delete": {"description": "Delete Recording", "operationId": "deleteSiteRfdiagRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/delete-site-rfdiag-recording"}, "get": {"description": "Get RF Diage Recording Details", "operationId": "getSiteRfdiagRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/get-site-rfdiag-recording"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rfdiag_id"}], "put": {"description": "Update Recording", "operationId": "updateSiteRfdiagRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/update-site-rfdiag-recording"}}, "paths": {"download": {"specs": {"get": {"description": "Download Recording\nDownload raw_events blob", "operationId": "downloadSiteRfdiagRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/download-site-rfdiag-recording"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rfdiag_id"}]}}, "stop": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rfdiag_id"}], "post": {"description": "If the recording session is active for the given rfdiag_id, it will finish the recording. duration and end_time will be updated to reflect the correct values.", "operationId": "stopSiteRfdiagRecording", "tags": ["Sites Rfdiags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rfdiags/stop-site-rfdiag-recording"}}}}}}}, "rftemplates": {"paths": {"derived": {"specs": {"get": {"description": "Get derived RF Templates for Site", "operationId": "listSiteRfTemplateDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites RF Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rf-templates/list-site-rf-template-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "rogues": {"paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Rogue Events", "operationId": "countSiteRogueEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_rogue_events_count_distinct"}}, {"$ref": "#/components/parameters/rogue_type"}, {"description": "ssid of the network detected as threat", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "bssid of the network detected as threat", "in": "query", "name": "bssid", "schema": {"type": "string"}}, {"description": "mac of the device that had strongest signal strength for ssid/bssid pair", "in": "query", "name": "ap_mac", "schema": {"type": "string"}}, {"description": "channel over which ap_mac heard ssid/bssid pair", "in": "query", "name": "channel", "schema": {"type": "string"}}, {"description": "whether the reporting AP see a wireless client (on LAN) connecting to it", "in": "query", "name": "seen_on_lan", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Rogues"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rogues/count-site-rogue-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Rogue Events", "operationId": "searchSiteRogueEvents", "parameters": [{"$ref": "#/components/parameters/rogue_type"}, {"description": "ssid of the network detected as threat", "in": "query", "name": "ssid", "schema": {"type": "string"}}, {"description": "bssid of the network detected as threat", "in": "query", "name": "bssid", "schema": {"type": "string"}}, {"description": "mac of the device that had strongest signal strength for ssid/bssid pair", "in": "query", "name": "ap_mac", "schema": {"type": "string"}}, {"description": "channel over which ap_mac heard ssid/bssid pair", "in": "query", "name": "channel", "schema": {"type": "integer"}}, {"description": "whether the reporting AP see a wireless client (on LAN) connecting to it", "in": "query", "name": "seen_on_lan", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Rogues"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rogues/search-site-rogue-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "{rogue_bssid}": {"specs": {"get": {"description": "Get Rogue AP Details", "operationId": "getSiteRogueAP", "tags": ["Sites Rogues"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rogues/get-site-rogue-a-p"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rogue_bssid"}]}, "paths": {"deauth_clients": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rogue_bssid"}], "post": {"description": "Send Deauth frame to clients connected to a Rogue AP", "operationId": "deauthSiteWirelessClientsConnectedToARogue", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/deauth-site-wireless-clients-connected-to-a-rogue"}}}}}}}, "rrm": {"paths": {"current": {"specs": {"get": {"description": "Get Current Channel Planning", "operationId": "getSiteCurrentChannelPlanning", "tags": ["Sites RRM"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rrm/get-site-current-channel-planning"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"devices": {"paths": {"{device_id}": {"paths": {"band": {"paths": {"{band}": {"specs": {"get": {"description": "Get Current RRM Considerations for an AP on a Specific Band", "operationId": "getSiteCurrentRrmConsiderations", "tags": ["Sites RRM"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rrm/get-site-current-rrm-considerations"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}, {"description": "802.11 Band", "in": "path", "name": "band", "required": true, "schema": {"$ref": "#/components/schemas/dot11_band"}}]}}}}}}}}}}, "events": {"specs": {"get": {"description": "Get Site RRM Events", "operationId": "getSiteRrmEvents", "parameters": [{"$ref": "#/components/parameters/dot11_band"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites RRM"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rrm/get-site-rrm-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "neighbors": {"paths": {"band": {"paths": {"{band}": {"specs": {"get": {"description": "Get Current RRM observed neighbors", "operationId": "getSiteCurrentRrmNeighbors", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites RRM"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rrm/get-site-current-rrm-neighbors"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"description": "802.11 Band", "in": "path", "name": "band", "required": true, "schema": {"$ref": "#/components/schemas/dot11_band"}}]}}}}}}, "optimize": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Optimize Site RRM", "operationId": "optimizeSiteRrm", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/optimize-site-rrm"}}}}}, "rssizones": {"specs": {"get": {"description": "Get List of Site RSSI Zone (RSSI-based)", "operationId": "listSiteRssiZones", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites RSSI Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rssi-zones/list-site-rssi-zones"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create RSSI Zone", "operationId": "createSiteRssiZone", "tags": ["Sites RSSI Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rssi-zones/create-site-rssi-zone"}}, "paths": {"{rssizone_id}": {"specs": {"delete": {"description": "Delete Site RSSI Zone", "operationId": "deleteSiteRssiZone", "tags": ["Sites RSSI Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rssi-zones/delete-site-rssi-zone"}, "get": {"description": "Get Site RSSI Zone details", "operationId": "getSiteRssiZone", "tags": ["Sites RSSI Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rssi-zones/get-site-rssi-zone"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/rssizone_id"}], "put": {"description": "Update Site RSSI Zone", "operationId": "updateSiteRssiZone", "tags": ["Sites RSSI Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/rssi-zones/update-site-rssi-zone"}}}}}, "secintelprofiles": {"paths": {"derived": {"specs": {"get": {"description": "Get derived Sky-ATP secintel profiles for Site", "operationId": "listSiteSecIntelProfilesDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites SecIntel Profiles"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/secintel-profiles/list-site-sec-intel-profiles-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "servicepolicies": {"paths": {"derived": {"specs": {"get": {"description": "Retrieves the list of Service Policies available for the Site", "operationId": "listSiteServicePoliciesDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Service Policies"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/service-policies/list-site-service-policies-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "services": {"paths": {"derived": {"specs": {"get": {"description": "Retrieves the list of Services available for the Site", "operationId": "listSiteServicesDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/services/list-site-services-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "events": {"paths": {"count": {"specs": {"get": {"description": "Count Service Path Events", "operationId": "countSiteServicePathEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_service_events_count_distinct"}}, {"description": "Event type, e.g. GW_SERVICE_PATH_DOWN", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "Description of the event including the reason it is triggered", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "Peer name", "in": "query", "name": "vpn_name", "schema": {"type": "string"}}, {"description": "Peer path name", "in": "query", "name": "vpn_path", "schema": {"type": "string"}}, {"description": "Service policy associated with that specific path", "in": "query", "name": "policy", "schema": {"type": "string"}}, {"description": "Network interface", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "Device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "Device firmware version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"description": "Start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/services/count-site-service-path-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Service Path Events", "operationId": "searchSiteServicePathEvents", "parameters": [{"description": "Event type, e.g. GW_SERVICE_PATH_DOWN", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "Description of the event including the reason it is triggered", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "Port ID of the peer gateway", "in": "query", "name": "peer_port_id", "schema": {"type": "string"}}, {"description": "MAC address of the peer gateway", "in": "query", "name": "peer_mac", "schema": {"type": "string"}}, {"description": "Peer name", "in": "query", "name": "vpn_name", "schema": {"type": "string"}}, {"description": "Peer path name", "in": "query", "name": "vpn_path", "schema": {"type": "string"}}, {"description": "Service policy associated with that specific path", "in": "query", "name": "policy", "schema": {"type": "string"}}, {"description": "Network interface", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "Device model", "in": "query", "name": "model", "schema": {"type": "string"}}, {"description": "Device firmware version", "in": "query", "name": "version", "schema": {"type": "string"}}, {"description": "Start time, in epoch", "in": "query", "name": "timestamp", "schema": {"type": "number"}}, {"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Services"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/services/search-site-service-path-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}}}, "setting": {"specs": {"get": {"description": "Get the Derived Site Settings, generated by merging the Org level templates (network templates, gateway templates) and the Site level configuration. If the same parameter is defined in both scopes, the Site level one is used.", "operationId": "getSiteSetting", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/get-site-setting"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "put": {"description": "Update Site Settings", "operationId": "updateSiteSettings", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/update-site-settings"}}, "paths": {"blacklist": {"specs": {"delete": {"description": "Delete Site Blacklist Station Clients", "operationId": "deleteSiteWirelessClientsBlocklist", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/delete-site-wireless-clients-blocklist"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "This endpoint is to provide list of client macs for annotation blacklist.\n\nRetrieve the current clients list `blacklist_url` under Site:Setting", "operationId": "createSiteWirelessClientsBlocklist", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/create-site-wireless-clients-blocklist"}}}, "derived": {"specs": {"get": {"description": "Get Site Settings", "operationId": "getSiteSettingDerived", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/get-site-setting-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "jse": {"paths": {"info": {"specs": {"get": {"description": "Retrieves the list of JSE orgs associated with the account", "operationId": "getSiteJseInfo", "tags": ["Sites JSE"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/jse/get-site-jse-info"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "watched_station": {"specs": {"delete": {"description": "Delete Site Watched Station Clients", "operationId": "deleteSiteWatchedStations", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/delete-site-watched-stations"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "This endpoint is to provide list of client macs for annotation as watched station.\n\nRetrieve the current clients list from `watched_station_url` under Site:Setting", "operationId": "createSiteWatchedStations", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/create-site-watched-stations"}}}, "whitelist": {"specs": {"delete": {"description": "Delete Site Whitelist Station Clients", "operationId": "deleteSiteWirelessClientsAllowlist", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/delete-site-wireless-clients-allowlist"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "This endpoint is to provide list of client macs for annotation as whitelist.\n\nRetrieve the current clients list from `whitelist_url` under Site:Setting", "operationId": "createSiteWirelessClientsAllowlist", "tags": ["Sites Setting"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/setting/create-site-wireless-clients-allowlist"}}}}}, "sitetemplates": {"paths": {"derived": {"specs": {"get": {"description": "Get derived Site Templates for Site", "operationId": "listSiteSiteTemplateDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"type": "boolean"}}], "tags": ["Sites Site Templates"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/site-templates/list-site-site-template-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "skyatp": {"paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Skyatp Events (WIP)", "operationId": "countSiteSkyatpEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_sky_atp_events_count_distinct"}}, {"description": "event type, e.g. cc, fs, mw", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "client MAC", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device MAC", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "threat level", "in": "query", "name": "threat_level", "schema": {"type": "integer"}}, {"$ref": "#/components/parameters/ip"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Skyatp"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/skyatp/count-site-skyatp-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Skyatp Events (WIP)", "operationId": "searchSiteSkyatpEvents", "parameters": [{"description": "event type, e.g. cc, fs, mw", "in": "query", "name": "type", "schema": {"type": "string"}}, {"description": "client MAC", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device MAC", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "threat level", "in": "query", "name": "threat_level", "schema": {"type": "integer"}}, {"$ref": "#/components/parameters/ip"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Skyatp"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/skyatp/search-site-skyatp-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}}}, "sle": {"paths": {"{scope}": {"paths": {"{scope_id}": {"paths": {"metric": {"paths": {"{metric}": {"paths": {"classifier": {"paths": {"{classifier}": {"paths": {"summary": {"specs": {"get": {"description": "Get SLE classifier details", "operationId": "getSiteSleClassifierDetails", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-classifier-details"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/sle_summary_scope"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}, {"in": "path", "name": "classifier", "required": true, "schema": {"type": "string"}}]}}}}}}, "classifiers": {"specs": {"get": {"description": "Get the list of classifiers for a specific metric", "operationId": "getSiteSleMetricClassifiers", "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-metric-classifiers"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_metric_classifiers_scope_parameters"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "histogram": {"specs": {"get": {"description": "Get the histogram for the SLE metric", "operationId": "getSiteSleHistogram", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-histogram"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_histogram_scope_parameters"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impact-summary": {"specs": {"get": {"description": "Get impact summary counts optionally filtered by classifier and failure type\n \n* Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge`\n* Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis`\n* WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`", "operationId": "getSiteSleImpactSummary", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "fields", "schema": {"$ref": "#/components/schemas/site_sle_impact_summary_fields_parameter"}}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impact-summary"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impact_summary_scope_parameters"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-applications": {"specs": {"get": {"description": "For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedApplications", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-applications"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_scope"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-aps": {"specs": {"get": {"description": "For Wireless SLEs. Get list of impacted APs optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedAps", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-aps"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_aps_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-chassis": {"specs": {"get": {"description": "For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedChassis", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-chassis"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_chassis_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-clients": {"specs": {"get": {"description": "For Wired SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedWiredClients", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-wired-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_clients_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-gateways": {"specs": {"get": {"description": "For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedGateways", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-gateways"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_gateways_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-interfaces": {"specs": {"get": {"description": "For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedInterfaces", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-interfaces"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_interfaces_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted-switches": {"specs": {"get": {"description": "For Wired SLEs. Get list of impacted switches optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedSwitches", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-switches"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_switches_scope_parameters"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "impacted_users": {"specs": {"get": {"description": "For Wireless SLEs. Get list of impacted wireless users optionally filtered by classifier and failure type", "operationId": "getSiteSleImpactedWirelessClients", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"in": "query", "name": "classifier", "schema": {"type": "string"}}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-impacted-wireless-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_impacted_users_scope_parameter"}}, {"in": "path", "name": "scope_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "summary": {"specs": {"get": {"description": "Get the summary for the SLE metric", "operationId": "getSiteSleSummary", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-summary"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_metric_summary_scope_parameters"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}]}}, "threshold": {"specs": {"get": {"description": "Get the SLE threshold", "operationId": "getSiteSleThreshold", "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sle-threshold"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_threshold_scope_parameter"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}, {"description": "values from /api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}], "post": {"description": "Replace the SLE threshold", "operationId": "replaceSiteSleThreshold", "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/replace-site-sle-threshold"}, "put": {"description": "Update the SLE threshold", "operationId": "updateSiteSleThreshold", "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/update-site-sle-threshold"}}}}}}}, "metrics": {"specs": {"get": {"description": "Get the list of metrics for the given scope", "operationId": "getSiteSlesMetrics", "tags": ["Sites SLEs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/sles/get-site-sles-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"in": "path", "name": "scope", "required": true, "schema": {"$ref": "#/components/schemas/site_sle_metrics_scope_parameters"}}, {"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`", "in": "path", "name": "scope_id", "required": true, "schema": {"type": "string"}}]}}}}}}}}, "ssr": {"paths": {"upgrade": {"paths": {"{upgrade_id}": {"specs": {"get": {"description": "Get Specific Site SSR Upgrade", "operationId": "getSiteSsrUpgrade", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/get-site-ssr-upgrade"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/upgrade_id"}]}}}}, "{device_id}": {"paths": {"upgrade": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}], "post": {"description": "Upgrade Site SSR device", "operationId": "upgradeSsr", "tags": ["Utilities Upgrade"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/upgrade/upgrade-ssr"}}}}}}}, "stats": {"specs": {"get": {"description": "Get Sites Stats", "operationId": "getSiteStats", "tags": ["Sites Stats"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/get-site-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"apps": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Applications", "operationId": "countSiteApps", "parameters": [{"description": "Default for wireless devices is `ap`. Default for wired devices is `device_mac`", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_apps_count_distinct"}}, {"description": "MAC of the device", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "Application name", "in": "query", "name": "app", "schema": {"type": "string"}}, {"description": "If a device is wired or wireless. Default is False.", "in": "query", "name": "wired", "schema": {"type": "string"}}], "tags": ["Sites Stats - Apps"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/apps/count-site-apps"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "assets": {"specs": {"get": {"description": "Get List of Site Assets Stats", "operationId": "listSiteAssetsStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/list-site-assets-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"asset_id": {"specs": {"get": {"description": "Get Site Asset Details", "operationId": "getSiteAssetStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/get-site-asset-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "count": {"specs": {"get": {"description": "Count Asset by distinct field", "operationId": "countSiteAssets", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_assets_count_distinct"}}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/count-site-assets"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Assets Search", "operationId": "searchSiteAssets", "parameters": [{"in": "query", "name": "mac", "schema": {"type": "string"}}, {"in": "query", "name": "map_id", "schema": {"type": "string"}}, {"in": "query", "name": "ibeacon_uuid", "schema": {"type": "string"}}, {"in": "query", "name": "ibeacon_major", "schema": {"type": "integer"}}, {"in": "query", "name": "ibeacon_minor", "schema": {"type": "integer"}}, {"in": "query", "name": "eddystone_uid_namespace", "schema": {"type": "string"}}, {"in": "query", "name": "eddystone_uid_instance", "schema": {"type": "string"}}, {"in": "query", "name": "eddystone_url", "schema": {"type": "string"}}, {"in": "query", "name": "device_name", "schema": {"type": "string"}}, {"in": "query", "name": "by", "schema": {"type": "string"}}, {"in": "query", "name": "name", "schema": {"type": "string"}}, {"in": "query", "name": "ap_mac", "schema": {"type": "string"}}, {"in": "query", "name": "beam", "schema": {"type": "string"}}, {"in": "query", "name": "rssi", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/search-site-assets"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "beacons": {"specs": {"get": {"description": "Get List of Site Beacons Stats", "operationId": "listSiteBeaconsStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Beacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/beacons/list-site-beacons-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "bgp_peers": {"paths": {"count": {"specs": {"get": {"description": "Count BGP Stats", "operationId": "countSiteBgpStats", "parameters": [{"in": "query", "name": "state", "schema": {"type": "string"}}, {"in": "query", "name": "distinct", "schema": {"type": "string"}}], "tags": ["Sites Stats - BGP Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/bgp-peers/count-site-bgp-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search BGP Stats", "operationId": "searchSiteBgpStats", "tags": ["Sites Stats - BGP Peers"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/bgp-peers/search-site-bgp-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "calls": {"paths": {"client": {"paths": {"{client_mac}": {"paths": {"troubleshoot": {"specs": {"get": {"description": "Troubleshoot a call", "operationId": "troubleshootSiteCall", "parameters": [{"description": "meeting_id", "in": "query", "name": "meeting_id", "required": true, "schema": {"type": "string"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Third party app name", "in": "query", "name": "app", "schema": {"example": "zoom", "type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Calls"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/calls/troubleshoot-site-call"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}]}}}}}}, "count": {"specs": {"get": {"description": "Count by Distinct Attributes of Calls", "operationId": "countSiteCalls", "parameters": [{"in": "query", "name": "distrinct", "schema": {"$ref": "#/components/schemas/count_site_calls_distrinct"}}, {"description": "feedback rating (e.g. \"rating=1\" or \"rating=1,2\")", "in": "query", "name": "rating", "schema": {"maximum": 5, "minimum": 1, "type": "integer"}}, {"in": "query", "name": "app", "schema": {"type": "string"}}, {"in": "query", "name": "start", "schema": {"type": "string"}}, {"in": "query", "name": "end", "schema": {"type": "string"}}], "tags": ["Sites Stats - Calls"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/calls/count-site-calls"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Calls", "operationId": "searchSiteCalls", "parameters": [{"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Third party app name", "in": "query", "name": "app", "schema": {"example": "zoom", "type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Calls"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/calls/search-site-calls"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "summary": {"specs": {"get": {"description": "Summarized, aggregated stats for the site calls", "operationId": "getSiteCallsSummary", "parameters": [{"description": "AP MAC, optional", "in": "query", "name": "ap_mac", "schema": {"type": "string"}}, {"description": "app name (`zoom` or `teams`). default is both. Optional", "in": "query", "name": "app", "schema": {"example": "zoom", "type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}], "tags": ["Sites Stats - Calls"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/calls/get-site-calls-summary"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "troubleshoot": {"specs": {"get": {"description": "Summary of calls troubleshoot by site", "operationId": "listSiteTroubleshootCalls", "parameters": [{"description": "AP MAC", "in": "query", "name": "ap", "schema": {"type": "string"}}, {"description": "meeting_id", "in": "query", "name": "meeting_id", "schema": {"type": "string"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Third party app name", "in": "query", "name": "app", "schema": {"example": "zoom", "type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Calls"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/calls/list-site-troubleshoot-calls"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "clients": {"specs": {"get": {"description": "Get List of Site All Clients Stats Details", "operationId": "listSiteWirelessClientsStats", "parameters": [{"in": "query", "name": "wired", "schema": {"default": false, "type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Clients Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-wireless/list-site-wireless-clients-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"{client_mac}": {"specs": {"get": {"description": "Get Site Client Stats Details", "operationId": "getSiteWirelessClientStats", "parameters": [{"in": "query", "name": "wired", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites Stats - Clients Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-wireless/get-site-wireless-client-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}]}}}}, "devices": {"specs": {"get": {"description": "Get List of Site Devices Stats", "operationId": "listSiteDevicesStats", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/device_type_with_all"}}, {"in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/stat_device_status_filter"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/list-site-devices-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"{device_id}": {"specs": {"get": {"description": "Get Site Device Stats Details", "operationId": "getSiteDeviceStats", "parameters": [{"$ref": "#/components/parameters/fields"}], "tags": ["Sites Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-device-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}]}, "paths": {"clients": {"specs": {"get": {"description": "Get wireless client stat by Device", "operationId": "getSiteAllClientsStatsByDevice", "tags": ["Sites Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-all-clients-stats-by-device"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/device_id"}]}}}}}}, "discovered_assets": {"specs": {"get": {"description": "Get List of Site Discovered BLE Assets that doesn\u2019t match any of the Asset / Assetfilters", "operationId": "listSiteDiscoveredAssets", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/list-site-discovered-assets"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "discovered_switch_metrics": {"paths": {"search": {"specs": {"get": {"description": "Search Discovered Switch Metrics", "operationId": "searchSiteDiscoveredSwitchesMetrics", "parameters": [{"description": "metric scope", "in": "query", "name": "scope", "schema": {"$ref": "#/components/schemas/discovered_switches_metric_scope"}}, {"description": "metric type", "in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/discovered_switch_metric_type"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Discovered Switches"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/discovered-switches/search-site-discovered-switches-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "discovered_switches": {"paths": {"count": {"specs": {"get": {"description": "Count Discovered Switches", "operationId": "countSiteDiscoveredSwitches", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_discovered_switches_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Discovered Switches"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/discovered-switches/count-site-discovered-switches"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "metrics": {"specs": {"get": {"description": "Discovered switches related metrics, lists related switch system names & details if not compliant", "operationId": "getSiteDiscoveredSwitchesMetrics", "parameters": [{"description": "configurable # ap per switch threshold, default 12", "in": "query", "name": "threshold", "schema": {"type": "string"}}, {"description": "system name for switch level metrics, optional", "in": "query", "name": "system_name", "schema": {"type": "string"}}], "tags": ["Sites Stats - Discovered Switches"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/discovered-switches/get-site-discovered-switches-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Discovered Switches", "operationId": "searchSiteDiscoveredSwitches", "parameters": [{"in": "query", "name": "adopted", "schema": {"type": "boolean"}}, {"in": "query", "name": "system_name", "schema": {"type": "string"}}, {"in": "query", "name": "hostname", "schema": {"type": "string"}}, {"in": "query", "name": "vendor", "schema": {"type": "string"}}, {"in": "query", "name": "model", "schema": {"type": "string"}}, {"in": "query", "name": "version", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Discovered Switches"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/discovered-switches/search-site-discovered-switches"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "filtered_assets": {"specs": {"get": {"description": "Get a list of BLE beacons that matches Asset or AssetFilter", "operationId": "getSiteAssetsOfInterest", "parameters": [{"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/get-site-assets-of-interest"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "gateways": {"paths": {"metrics": {"specs": {"get": {"description": "Get Site Gateway Metrics", "operationId": "getSiteGatewayMetrics", "tags": ["Sites Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-gateway-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "maps": {"paths": {"{map_id}": {"paths": {"clients": {"specs": {"get": {"description": "Get Site Clients Stats By Map", "operationId": "getSiteWirelessClientsStatsByMap", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Clients Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-wireless/get-site-wireless-clients-stats-by-map"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}]}}, "discovered_assets": {"specs": {"get": {"description": "Get a list of BLE beacons that we discovered (whether they\u2019 re defined as assets or not)", "operationId": "getSiteDiscoveredAssetByMap", "tags": ["Sites Stats - Assets"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/assets/get-site-discovered-asset-by-map"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}]}}, "sdkclients": {"specs": {"get": {"description": "Get SdkClient Stats By Map", "operationId": "getSiteSdkStatsByMap", "tags": ["Sites Stats - Clients SDK"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-sdk/get-site-sdk-stats-by-map"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}]}}, "unconnected_clients": {"specs": {"get": {"description": "Get List of Site Unconnected Client Location", "operationId": "listSiteUnconnectedClientStats", "tags": ["Sites Stats - Clients Wireless"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-wireless/list-site-unconnected-client-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/map_id"}]}}}}}}, "mxedges": {"specs": {"get": {"description": "Get List of Site MxEdges Stats", "operationId": "listSiteMxEdgesStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/mxedges/list-site-mx-edges-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}, "paths": {"{mxedge_id}": {"specs": {"get": {"description": "Get One Site MxEdge Stats", "operationId": "getSiteMxEdgeStats", "parameters": [{"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - MxEdges"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/mxedges/get-site-mx-edge-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/mxedge_id"}]}}}}, "ports": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Switch/Gateway Ports", "operationId": "countSiteSwOrGwPorts", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_ports_count_distinct"}}, {"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/count_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/count_ports_stp_role"}}, {"description": "if `up`==`true` && has Authenticator role", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/count_ports_auth_state"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/ports/count-site-sw-or-gw-ports"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Switch / Gateway Ports", "operationId": "searchSiteSwOrGwPorts", "parameters": [{"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device type", "in": "query", "name": "device_type", "schema": {"$ref": "#/components/schemas/search_site_sw_or_gw_ports_device_type"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Output errors", "in": "query", "name": "tx_errors", "schema": {"type": "integer"}}, {"description": "Input errors", "in": "query", "name": "rx_errors", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "Limit on number of dynamically learned macs", "in": "query", "name": "mac_limit", "schema": {"type": "integer"}}, {"description": "Number of mac addresses in the forwarding table", "in": "query", "name": "mac_count", "schema": {"type": "integer"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"description": "indicates if interface is active/inactive", "in": "query", "name": "active", "schema": {"type": "boolean"}}, {"description": "Last sampled jitter of the interface", "in": "query", "name": "jitter", "schema": {"type": "number"}}, {"description": "Last sampled loss of the interface", "in": "query", "name": "loss", "schema": {"type": "number"}}, {"description": "Last sampled latency of the interface", "in": "query", "name": "latency", "schema": {"type": "number"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/search_site_sw_or_gw_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/search_site_sw_or_gw_ports_stp_role"}}, {"description": "Optic Slot Partnumber, Check for null/empty", "in": "query", "name": "xcvr_part_number", "schema": {"type": "string"}}, {"description": "if `up`==`true` && has Authenticator role", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/search_site_sw_or_gw_ports_auth_state"}}, {"description": "LTE IMSI value, Check for null/empty", "in": "query", "name": "lte_imsi", "schema": {"type": "string"}}, {"description": "LTE ICCID value, Check for null/empty", "in": "query", "name": "lte_iccid", "schema": {"type": "string"}}, {"description": "LTE IMEI value, Check for null/empty", "in": "query", "name": "lte_imei", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/ports/search-site-sw-or-gw-ports"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "sdkclients": {"paths": {"{sdkclient_id}": {"specs": {"get": {"description": "Get Detail Stats of a SdkClient", "operationId": "getSiteSdkStats", "tags": ["Sites Stats - Clients SDK"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/clients-sdk/get-site-sdk-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/sdkclient_id"}]}}}}, "switch_ports": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Switch/Gateway Ports", "operationId": "countSiteSwitchPorts", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_switch_ports_count_distinct"}}, {"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/count_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/count_ports_stp_role"}}, {"description": "if `up`==`true`", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/count_ports_auth_state"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/ports/count-site-switch-ports"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Switch / Gateway Ports", "operationId": "searchSiteSwitchPorts", "parameters": [{"description": "indicates full or half duplex", "in": "query", "name": "full_duplex", "schema": {"type": "boolean"}}, {"description": "device identifier", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Chassis identifier of the chassis type listed", "in": "query", "name": "neighbor_mac", "schema": {"type": "string"}}, {"description": "Description supplied by the system on the interface E.g. \u201cGigabitEthernet2/0/39\u201d", "in": "query", "name": "neighbor_port_desc", "schema": {"type": "string"}}, {"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \u201cKumar-Acc-SW.mist.local\u201d", "in": "query", "name": "neighbor_system_name", "schema": {"type": "string"}}, {"description": "is the POE configured not be disabled.", "in": "query", "name": "poe_disabled", "schema": {"type": "boolean"}}, {"description": "poe mode depending on class E.g. \u201c802.3at\u201d", "in": "query", "name": "poe_mode", "schema": {"type": "string"}}, {"description": "is the device attached to POE", "in": "query", "name": "poe_on", "schema": {"type": "boolean"}}, {"description": "interface name", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "interface mac address", "in": "query", "name": "port_mac", "schema": {"type": "string"}}, {"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts.", "in": "query", "name": "power_draw", "schema": {"type": "number"}}, {"description": "Output packets", "in": "query", "name": "tx_pkts", "schema": {"type": "integer"}}, {"description": "Input packets", "in": "query", "name": "rx_pkts", "schema": {"type": "integer"}}, {"description": "Input bytes", "in": "query", "name": "rx_bytes", "schema": {"type": "integer"}}, {"description": "Output rate", "in": "query", "name": "tx_bps", "schema": {"type": "integer"}}, {"description": "Input rate", "in": "query", "name": "rx_bps", "schema": {"type": "integer"}}, {"description": "Multicast output packets", "in": "query", "name": "tx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast output packets", "in": "query", "name": "tx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "Multicast input packets", "in": "query", "name": "rx_mcast_pkts", "schema": {"type": "integer"}}, {"description": "Broadcast input packets", "in": "query", "name": "rx_bcast_pkts", "schema": {"type": "integer"}}, {"description": "port speed", "in": "query", "name": "speed", "schema": {"type": "integer"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_state", "schema": {"$ref": "#/components/schemas/search_site_switch_ports_stp_state"}}, {"description": "if `up`==`true`", "in": "query", "name": "stp_role", "schema": {"$ref": "#/components/schemas/search_site_switch_ports_stp_role"}}, {"description": "if `up`==`true` && has Authenticator role", "in": "query", "name": "auth_state", "schema": {"$ref": "#/components/schemas/search_site_switch_ports_auth_state"}}, {"description": "indicates if interface is up", "in": "query", "name": "up", "schema": {"type": "boolean"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Stats - Ports"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/ports/search-site-switch-ports"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "switches": {"paths": {"metrics": {"specs": {"get": {"description": "Get version compliance metrics for managed or monitored switches", "operationId": "getSiteSwitchesMetrics", "parameters": [{"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/switch_metric_type"}}, {"in": "query", "name": "scope", "schema": {"$ref": "#/components/schemas/switch_metric_scope"}}, {"description": "switch mac, used only with metric `type`==`active_ports_summary`", "in": "query", "name": "switch_mac", "schema": {"type": "string"}}], "tags": ["Sites Stats - Devices"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/devices/get-site-switches-metrics"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "wxrules": {"specs": {"get": {"description": "Get Wxlan Rule usage", "operationId": "getSiteWxRulesUsage", "tags": ["Sites Stats - WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/wxrules/get-site-wx-rules-usage"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "zones": {"specs": {"get": {"description": "Get List of Site Zones Stats", "operationId": "listSiteZonesStats", "parameters": [{"example": "00000000-0000-0000-0000-000000000000", "in": "query", "name": "map_id", "schema": {"type": "string"}}], "tags": ["Sites Stats - Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/zones/list-site-zones-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{zone_type}": {"paths": {"{zone_id}": {"specs": {"get": {"description": "Get Detail Zone Stats", "operationId": "getSiteZoneStats", "tags": ["Sites Stats - Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/stats/zones/get-site-zone-stats"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/zone_type"}, {"$ref": "#/components/parameters/zone_id"}]}}}}}}, "subscriptions": {"specs": {"delete": {"description": "Unsubscribe to Site Alarms", "operationId": "UnsubscribeSiteAlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/unsubscribe-site-alarms"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Subscribe to Site Alarms", "operationId": "SubscribeSiteAlarms", "tags": ["Sites Alarms"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/alarms/subscribe-site-alarms"}}}, "synthetic_test": {"specs": {"get": {"description": "Get Synthetic Testing Status", "operationId": "getSiteSyntheticTestStatus", "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/get-site-synthetic-test-status"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Trigger Synthetic Testing", "operationId": "triggerSiteSyntheticTest", "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/trigger-site-synthetic-test"}}, "paths": {"search": {"specs": {"get": {"description": "Search Site Synthetic Testing", "operationId": "searchSiteSyntheticTest", "parameters": [{"description": "Device MAC Address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "port_id used to run the test (for SSR only)", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "VLAN ID", "in": "query", "name": "vlan_id", "schema": {"type": "string"}}, {"description": "entity who triggers the test", "in": "query", "name": "by", "schema": {"type": "string"}}, {"description": "test failure reason", "in": "query", "name": "reason", "schema": {"type": "string"}}, {"description": "synthetic test type", "in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/synthetictest_type"}}, {"description": "connectivity protocol", "in": "query", "name": "protocol", "schema": {"$ref": "#/components/schemas/synthetictest_protocol"}}, {"description": "tenant network in which lan_connectivity test was run", "in": "query", "name": "tenant", "schema": {"type": "string"}}], "tags": ["Sites Synthetic Tests"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/synthetic-tests/search-site-synthetic-test"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "uisettings": {"specs": {"get": {"description": "Site UI settings", "operationId": "listSiteUiSettings", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/list-site-ui-settings"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Site UI settings", "operationId": "createSiteUiSettings", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/create-site-ui-settings"}}, "paths": {"derived": {"specs": {"get": {"description": "Get both site UI settings(for_site=true) and org UI settings (for_site=false)", "operationId": "listSiteUiSettingDerived", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/list-site-ui-setting-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{uisetting_id}": {"specs": {"delete": {"description": "Site UI settings", "operationId": "deleteSiteUiSetting", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/delete-site-ui-setting"}, "get": {"description": "Site UI settings", "operationId": "getSiteUiSetting", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/get-site-ui-setting"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/uisetting_id"}], "post": {"description": "Site UI settings", "operationId": "updateSiteUiSetting", "tags": ["Sites UI Settings"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/ui-settings/update-site-ui-setting"}}}}}, "vbeacons": {"specs": {"get": {"description": "Get List of Site Virtual Beacons", "operationId": "listSiteVBeacons", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites vBeacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vbeacons/list-site-v-beacons"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Virtual Beacon", "operationId": "createSiteVBeacon", "tags": ["Sites vBeacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vbeacons/create-site-v-beacon"}}, "paths": {"{vbeacon_id}": {"specs": {"delete": {"description": "Delete Site Virtual Beacon", "operationId": "deleteSiteVBeacon", "tags": ["Sites vBeacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vbeacons/delete-site-v-beacon"}, "get": {"description": "Get Site Virtual Beacon Details", "operationId": "getSiteVBeacon", "tags": ["Sites vBeacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vbeacons/get-site-v-beacon"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/vbeacon_id"}], "put": {"description": "Update Site Virtual Beacon", "operationId": "updateSiteVBeacon", "tags": ["Sites vBeacons"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vbeacons/update-site-v-beacon"}}}}}, "vpns": {"paths": {"derived": {"specs": {"get": {"description": "VPN object represents an overlay network where gateways can participate in and optionally expose routes to.", "operationId": "listSiteVpnsDerived", "parameters": [{"description": "whether resolve the site variables", "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}], "tags": ["Sites VPNs"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/vpns/list-site-vpns-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "wan_client": {"paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Site WAN Client-Events", "operationId": "countSiteWanClientEvents", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_wan_client_events_distinct"}}, {"$ref": "#/components/parameters/client_event_type"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wan/count-site-wan-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}}}, "wan_clients": {"paths": {"count": {"specs": {"get": {"description": "Count Site WAN Clients", "operationId": "countSiteWanClients", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_wan_clients_count_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wan/count-site-wan-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "events": {"paths": {"search": {"specs": {"get": {"description": "Search Site WAN Client Events", "operationId": "searchSiteWanClientEvents", "parameters": [{"$ref": "#/components/parameters/client_event_type"}, {"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "client IP", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "Manufacture", "in": "query", "name": "mfg", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wan/search-site-wan-client-events"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "search": {"specs": {"get": {"description": "Search Site WAN Clients", "operationId": "searchSiteWanClients", "parameters": [{"description": "partial / full MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "partial / full hostname", "in": "query", "name": "hostname", "schema": {"type": "string"}}, {"description": "client IP", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "Manufacture", "in": "query", "name": "mfg", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wan"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wan/search-site-wan-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "wan_usages": {"paths": {"count": {"specs": {"get": {"description": "Count Site WAN Uages", "operationId": "countSiteWanUsage", "parameters": [{"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Peer MAC address", "in": "query", "name": "peer_mac", "schema": {"type": "string"}}, {"description": "Port ID for the device", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "Peer Port ID for the device", "in": "query", "name": "peer_port_id", "schema": {"type": "string"}}, {"description": "policy for the wan path", "in": "query", "name": "policy", "schema": {"type": "string"}}, {"description": "tenant network in which the packet is sent", "in": "query", "name": "tenant", "schema": {"type": "string"}}, {"description": "path_type of the port", "in": "query", "name": "path_type", "schema": {"type": "string"}}, {"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/wan_usages_count_disctinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites WAN Usages"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wan-usages/count-site-wan-usage"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Site WAN Uages", "operationId": "searchSiteWanUsage", "parameters": [{"description": "MAC address", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "Peer MAC address", "in": "query", "name": "peer_mac", "schema": {"type": "string"}}, {"description": "Port ID for the device", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "Peer Port ID for the device", "in": "query", "name": "peer_port_id", "schema": {"type": "string"}}, {"description": "policy for the wan path", "in": "query", "name": "policy", "schema": {"type": "string"}}, {"description": "tenant network in which the packet is sent", "in": "query", "name": "tenant", "schema": {"type": "string"}}, {"description": "path_type of the port", "in": "query", "name": "path_type", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites WAN Usages"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wan-usages/search-site-wan-usage"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}}}, "webhooks": {"specs": {"get": {"description": "Get List of Site Webhooks", "operationId": "listSiteWebhooks", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/list-site-webhooks"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Webhook defines a webhook, modeled after [github\u2019s model](https://developer.github.com/webhooks/).\n\nThere is two types of webhooks:\n* webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114))\n* raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b))\n\n##### Webhooks\nWebhooks can be configured at the org level (subset of topics only) and at the site level. It is possible to have multiple topics in the same webhook configuration and/or to have multiple webhooks configured at the same time.\n\n##### Client Raw Data Webhooks\nRaw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client, identified by their advertising MAC address (assets, discovered ble, connected wifi, unconnected wifi). The data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry packets that the client may emit. Note that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client. In order to get the location data for a client please see our location webhooks. Clients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier).\n\n###### Client Raw Data Webhooks Topics\nTopics that correspond to client raw data for different client types. \n* `asset-raw-rssi` - Raw data from packets emitted by named and filtered assets \n* `discovered-raw-rssi` - Raw data from packets emitted by passive BLE devices \n* `wifi-conn-raw` - Raw data from packets emitted by connected devices \n* `wifi-unconn-raw` - Raw data from packets emitted by unconnected devices (passive)\n\n###### Rules for configuring client raw data webhooks\n1. Only one instance of a webhook object containing a client raw data webhook topic is allowed. (a site level entry will override an org level entry for the client raw data webhook topic in question)\n2. Only one client raw data webhook topic is allowed per `http-post` message to webhooks api\n", "operationId": "createSiteWebhook", "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/create-site-webhook"}}, "paths": {"{webhook_id}": {"specs": {"delete": {"description": "Delete Site Webhook", "operationId": "deleteSiteWebhook", "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/delete-site-webhook"}, "get": {"description": "Get Site Webhook Details", "operationId": "getSiteWebhook", "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/get-site-webhook"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/webhook_id"}], "put": {"description": "Update Site Webhook", "operationId": "updateSiteWebhook", "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/update-site-webhook"}}, "paths": {"events": {"paths": {"count": {"specs": {"get": {"description": "Count Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping", "operationId": "countSiteWebhooksDeliveries", "parameters": [{"in": "query", "name": "error", "schema": {"type": "string"}}, {"in": "query", "name": "status_code", "schema": {"type": "integer"}}, {"description": "webhook delivery status", "in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/webhook_delivery_status"}}, {"description": "webhook topic", "in": "query", "name": "topic", "schema": {"$ref": "#/components/schemas/webhook_delivery_topic"}}, {"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/webhook_delivery_distinct"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/count-site-webhooks-deliveries"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/webhook_id"}]}}, "search": {"specs": {"get": {"description": "Search Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping", "operationId": "searchSiteWebhooksDeliveries", "parameters": [{"in": "query", "name": "error", "schema": {"type": "string"}}, {"in": "query", "name": "status_code", "schema": {"type": "integer"}}, {"description": "webhook delivery status", "in": "query", "name": "status", "schema": {"$ref": "#/components/schemas/webhook_delivery_status"}}, {"description": "webhook topic", "in": "query", "name": "topic", "schema": {"$ref": "#/components/schemas/webhook_delivery_topic"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}], "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/search-site-webhooks-deliveries"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/webhook_id"}]}}}}, "ping": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/webhook_id"}], "post": {"description": "send a Ping event to the webhook", "operationId": "pingSiteWebhook", "tags": ["Sites Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/webhooks/ping-site-webhook"}}}}}}}, "wired_clients": {"paths": {"count": {"specs": {"get": {"description": "Count by Distinct Attributes of Clients", "operationId": "countSiteWiredClients", "parameters": [{"in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_wired_clients_count_distinct"}}, {"description": "client mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "device mac", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "port id", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "vlan", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Clients - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wired/count-site-wired-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "search": {"specs": {"get": {"description": "Search Wired Clients", "operationId": "searchSiteWiredClients", "parameters": [{"description": "device mac", "in": "query", "name": "device_mac", "schema": {"type": "string"}}, {"description": "client mac", "in": "query", "name": "mac", "schema": {"type": "string"}}, {"description": "client ip", "in": "query", "name": "ip", "schema": {"type": "string"}}, {"description": "port id", "in": "query", "name": "port_id", "schema": {"type": "string"}}, {"description": "vlan", "in": "query", "name": "vlan", "schema": {"type": "string"}}, {"description": "manufacture", "in": "query", "name": "manufacture", "schema": {"type": "string"}}, {"description": "single entry of hostname/mac", "in": "query", "name": "text", "schema": {"type": "string"}}, {"description": "nacrule_id", "in": "query", "name": "nacrule_id", "schema": {"type": "string"}}, {"description": "DHCP Hostname", "in": "query", "name": "dhcp_hostname", "schema": {"type": "string"}}, {"description": "DHCP FQDN", "in": "query", "name": "dhcp_fqdn", "schema": {"type": "string"}}, {"description": "DHCP Client Identifier", "in": "query", "name": "dhcp_client_identifier", "schema": {"type": "string"}}, {"description": "DHCP Vendor Class Identifier", "in": "query", "name": "dhcp_vendor_class_identifier", "schema": {"type": "string"}}, {"description": "DHCP Request Parameters", "in": "query", "name": "dhcp_request_params", "schema": {"type": "string"}}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}], "tags": ["Sites Clients - Wired"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/clients/wired/search-site-wired-clients"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{client_mac}": {"paths": {"coa": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/client_mac"}], "post": {"description": "Trigger a CoA (change of authorization) against a Wiired client", "operationId": "reauthSiteDot1xWiredClient", "tags": ["Utilities LAN"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/lan/reauth-site-dot1x-wired-client"}}}}}}}, "wlans": {"specs": {"get": {"description": "Get List of Site WLANs", "operationId": "listSiteWlans", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/list-site-wlans"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site WLAN", "operationId": "createSiteWlan", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/create-site-wlan"}}, "paths": {"derived": {"specs": {"get": {"description": "Get Wlans Derived", "operationId": "listSiteWlanDerived", "parameters": [{"description": "whether to resolve SITE_VARS", "example": true, "in": "query", "name": "resolve", "schema": {"default": false, "type": "boolean"}}, {"description": "filter by WLAN ID", "in": "query", "name": "wlan_id", "schema": {"type": "string"}}], "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/list-site-wlan-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{wlan_id}": {"specs": {"delete": {"description": "Delete Site WLAN", "operationId": "deleteSiteWlan", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/delete-site-wlan"}, "get": {"description": "Get Site WLAN", "operationId": "getSiteWlan", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/get-site-wlan"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wlan_id"}], "put": {"description": "Update Site WLAN", "operationId": "updateSiteWlan", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/update-site-wlan"}}, "paths": {"portal_image": {"specs": {"delete": {"description": "Delete Site WLAN Portal Image", "operationId": "deleteSiteWlanPortalImage", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/delete-site-wlan-portal-image"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wlan_id"}], "post": {"description": "Wlan Portal Image Upload", "operationId": "uploadSiteWlanPortalImage", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/upload-site-wlan-portal-image"}}}, "portal_template": {"specs": {"parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wlan_id"}], "put": {"description": "Update a Portal Template\n\n#### Sponsor Email Template\nSponsor Email Template supports following template variables:\n\n| **Name** | **Description** |\n| --- | --- |\n| approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized |\n| deny_url | Renders URL to reject the request |\n| guest_email | Renders Email ID of the guest |\n| guest_name | Renders Name of the guest |\n| field1 | Renders value of the Custom Field 1 |\n| field2 | Renders value of the Custom Field 2 |\n| company | Renders value of the Company field |\n| sponsor_link_validity_duration | Renders validity time of the request (i.e. Approve/Deny URL) |\n| auth_expire_minutes | Renders Wlan-level configured Guest Authorization Expiration time period (in minutes), If not configured then default (1 day in minutes) |", "operationId": "updateSiteWlanPortalTemplate", "tags": ["Sites Wlans"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wlans/update-site-wlan-portal-template"}}}}}}}, "wxrules": {"specs": {"get": {"description": "Get List of Site WxLan Rules", "operationId": "listSiteWxRules", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/list-site-wx-rules"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site WxLan Rule", "operationId": "createSiteWxRule", "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/create-site-wx-rule"}}, "paths": {"derived": {"specs": {"get": {"description": "Get Site WxLan Rule Derived", "operationId": "ListSiteWxRulesDerived", "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/list-site-wx-rules-derived"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{wxrule_id}": {"specs": {"delete": {"description": "Delete Site WxLan Rule", "operationId": "deleteSiteWxRule", "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/delete-site-wx-rule"}, "get": {"description": "Get Site WxLan Rule Details", "operationId": "getSiteWxRule", "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/get-site-wx-rule"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wxrule_id"}], "put": {"description": "Update Site WxLan Rule", "operationId": "updateSiteWxRule", "tags": ["Sites WxRules"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxrules/update-site-wx-rule"}}}}}, "wxtags": {"specs": {"get": {"description": "Get List of Site WxTags", "operationId": "listSiteWxTags", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/list-site-wx-tags"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site WxTag", "operationId": "createSiteWxTag", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/create-site-wx-tag"}}, "paths": {"apps": {"specs": {"get": {"description": "Get Application List", "operationId": "getSiteApplicationList", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/get-site-application-list"}, "parameters": [{"$ref": "#/components/parameters/site_id"}]}}, "{wxtag_id}": {"specs": {"delete": {"description": "Delete Site WxTag", "operationId": "deleteSiteWxTag", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/delete-site-wx-tag"}, "get": {"description": "Get Site WxTag Details", "operationId": "getSiteWxTag", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/get-site-wx-tag"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wxtag_id"}], "put": {"description": "Update Site WxTag", "operationId": "updateSiteWxTag", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/update-site-wx-tag"}}, "paths": {"clients": {"specs": {"get": {"description": "Get Current Matching Clients of a WXLAN Tag", "operationId": "getSiteCurrentMatchingClientsOfAWxTag", "tags": ["Sites WxTags"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtags/get-site-current-matching-clients-of-a-wx-tag"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wxtag_id"}]}}}}}}, "wxtunnels": {"specs": {"get": {"description": "Get List of Site WxLan Tunnels", "operationId": "listSiteWxTunnels", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtunnels/list-site-wx-tunnels"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site WxLan Tunnel", "operationId": "createSiteWxTunnel", "tags": ["Sites WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtunnels/create-site-wx-tunnel"}}, "paths": {"{wxtunnel_id}": {"specs": {"delete": {"description": "Delete Site WxLan Tunnel", "operationId": "deleteSiteWxTunnel", "tags": ["Sites WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtunnels/delete-site-wx-tunnel"}, "get": {"description": "Get Site WxLan tunnel Details", "operationId": "getSiteWxTunnel", "tags": ["Sites WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtunnels/get-site-wx-tunnel"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/wxtunnel_id"}], "put": {"description": "Update Site WxLan Tunnel", "operationId": "updateSiteWxTunnel", "tags": ["Sites WxTunnels"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/wxtunnels/update-site-wx-tunnel"}}}}}, "zones": {"specs": {"get": {"description": "Get List of Site Zones", "operationId": "listSiteZones", "parameters": [{"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/list-site-zones"}, "parameters": [{"$ref": "#/components/parameters/site_id"}], "post": {"description": "Create Site Zone", "operationId": "createSiteZone", "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/create-site-zone"}}, "paths": {"{zone_id}": {"specs": {"delete": {"description": "Delete Site Zone", "operationId": "deleteSiteZone", "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/delete-site-zone"}, "get": {"description": "Get Site Zone Details", "operationId": "getSiteZone", "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/get-site-zone"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/zone_id"}], "put": {"description": "Update Site Zone", "operationId": "updateSiteZone", "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/update-site-zone"}}}}}, "{zone_type}": {"paths": {"count": {"specs": {"get": {"description": "Count Site Zone Sessions", "operationId": "countSiteZoneSessions", "parameters": [{"example": "scope_id", "in": "query", "name": "distinct", "schema": {"$ref": "#/components/schemas/site_zone_count_distinct"}}, {"description": "user type", "in": "query", "name": "user_type", "schema": {"$ref": "#/components/schemas/rf_client_type"}}, {"description": "client MAC / Asset MAC / SDK UUID", "in": "query", "name": "user", "schema": {"type": "string"}}, {"description": "if `scope`==`map`/`zone`/`rssizone`, the scope id", "in": "query", "name": "scope_id", "schema": {"type": "string"}}, {"description": "scope", "in": "query", "name": "scope", "schema": {"$ref": "#/components/schemas/zone_scope"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/count-site-zone-sessions"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/zone_type"}]}}, "visits": {"paths": {"search": {"specs": {"get": {"description": "Search Zone Sessions", "operationId": "searchSiteZoneSessions", "parameters": [{"description": "user type, client (default) / sdkclient / asset", "in": "query", "name": "user_type", "schema": {"$ref": "#/components/schemas/rf_client_type"}}, {"description": "client MAC / Asset MAC / SDK UUID", "in": "query", "name": "user", "schema": {"type": "string"}}, {"description": "if `scope`==`map`/`zone`/`rssizone`, the scope id", "in": "query", "name": "scope_id", "schema": {"type": "string"}}, {"description": "scope", "in": "query", "name": "scope", "schema": {"$ref": "#/components/schemas/visits_scope"}}, {"$ref": "#/components/parameters/start"}, {"$ref": "#/components/parameters/end"}, {"$ref": "#/components/parameters/duration"}, {"$ref": "#/components/parameters/limit"}, {"$ref": "#/components/parameters/page"}], "tags": ["Sites Zones"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/sites/zones/search-site-zone-sessions"}, "parameters": [{"$ref": "#/components/parameters/site_id"}, {"$ref": "#/components/parameters/zone_type"}]}}}}}}}}}}, "utils": {"paths": {"test_telstra": {"specs": {"post": {"description": "Allows validation of Telstra sms gateway credentials.\n\nIn case of success, a text message confirming successful setup should be received. In case of error, telstra error message are returned.", "operationId": "testSiteWlanTelstraSetup", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/test-site-wlan-telstra-setup"}}}, "test_twilio": {"specs": {"post": {"description": "Allows validation of twilio setup\nIn case of success, a text message confirming successful setup should be received. In case of error, twilio error code and message are returned.", "operationId": "testSiteWlanTwilioSetup", "tags": ["Utilities Wi-Fi"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wi-fi/test-site-wlan-twilio-setup"}}}}}}}}}, "webhook_example": {"paths": {"_alarm_": {"specs": {"post": {"description": "Webhook sample for `alarm` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "alarms", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/alarms"}}}, "_asset_raw_": {"specs": {"post": {"description": "Webhook sample for `asset_raw` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages\n\n**will be deprecated after 06/30/2024**", "operationId": "assetRaw", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/asset-raw"}}}, "_audit_": {"specs": {"post": {"description": "Webhook sample for `audit` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "audits", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/audits"}}}, "_client_info_": {"specs": {"post": {"description": "Webhook sample for `client-info` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "clientInfo", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/client-info"}}}, "_client_join_": {"specs": {"post": {"description": "Webhook sample for `client_join` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "clientJoin", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/client-join"}}}, "_client_latency_": {"specs": {"post": {"description": "Webhook sample for `client-latency` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "client_latency", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/client_latency"}}}, "_client_sessions_": {"specs": {"post": {"description": "Webhook sample for `client_sessions` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "clientSessions", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/client-sessions"}}}, "_device_events_": {"specs": {"post": {"description": "Webhook sample for `device_events` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "deviceEvents", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/device-events"}}}, "_device_updowns_": {"specs": {"post": {"description": "Webhook sample for `device_updowns` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "deviceUpDown", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/device-up-down"}}}, "_discovered_raw_rssi_": {"specs": {"post": {"description": "Webhook sample for `discovered-raw-rssi` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "discovered-raw-rssi", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/discovered-raw-rssi"}}}, "_location_": {"specs": {"post": {"description": "Webhook sample for `location` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location"}}}, "_location_asset_": {"specs": {"post": {"description": "Webhook sample for `location_asset` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location_asset", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location_asset"}}}, "_location_centrak_": {"specs": {"post": {"description": "Webhook sample for `location_centrak` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location_centrak", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location_centrak"}}}, "_location_client_": {"specs": {"post": {"description": "Webhook sample for `location_client` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location_client", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location_client"}}}, "_location_sdk_": {"specs": {"post": {"description": "Webhook sample for `location_sdk` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location_sdk", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location_sdk"}}}, "_location_unclient_": {"specs": {"post": {"description": "Webhook sample for `location_unclient` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "location_unclient", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/location_unclient"}}}, "_nac_accounting_": {"specs": {"post": {"description": "Webhook sample for `nac-accounting` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "nacAccounting", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/nac-accounting"}}}, "_nac_events_": {"specs": {"post": {"description": "Example Delivery of nac_events", "operationId": "nac_events", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/nac_events"}}}, "_occupancy_alerts_": {"specs": {"post": {"description": "Webhook sample for `occupancy_alerts` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "occupancyAlerts", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/occupancy-alerts"}}}, "_ping_": {"specs": {"post": {"description": "Webhook sample for `ping` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "ping", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/ping"}}}, "_sdkclient_scan_data": {"specs": {"post": {"description": "Webhook sample for `sdkclient_scan_data` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "sdkclientScanData", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/sdkclient-scan-data"}}}, "_site_sle_": {"specs": {"post": {"description": "Webhook sample for `site_sle` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "site_sle", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/site_sle"}}}, "_zone_": {"specs": {"post": {"description": "Webhook sample for `zone` topic\n\n**Note**: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages", "operationId": "zone", "tags": ["Samples Webhooks"], "doc_url": "https://www.juniper.net/documentation/us/en/software/mist/api/http/api/samples/webhooks/zone"}}}}}}, "components": {"parameters": {"account_id": {"in": "path", "name": "account_id", "required": true, "schema": {"example": "iojzXIJWEuiD73ZvydOfg", "type": "string"}}, "admin_id": {"in": "path", "name": "admin_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "alarm_id": {"in": "path", "name": "alarm_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "alarmtemplate_id": {"in": "path", "name": "alarmtemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "apitoken_id": {"in": "path", "name": "apitoken_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "aptemplate_id": {"in": "path", "name": "aptemplate_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, "asset_id": {"in": "path", "name": "asset_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "assetfilter_id": {"in": "path", "name": "assetfilter_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "attachment_id": {"in": "path", "name": "attachment_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "avprofiles_id": {"in": "path", "name": "avprofiles_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "beacon_id": {"in": "path", "name": "beacon_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "client_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listDeviceEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "client_mac": {"in": "path", "name": "client_mac", "required": true, "schema": {"example": "0000000000ab", "pattern": "^[0-9a-fA-F]{12}$", "type": "string"}}, "country_code": {"description": "country code, in two-character", "in": "query", "name": "country_code", "schema": {"example": "US", "pattern": "^[a-zA-Z]{2}$", "type": "string"}}, "device_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listDeviceEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "device_id": {"in": "path", "name": "device_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "device_mac": {"in": "path", "name": "device_mac", "required": true, "schema": {"example": "0000000000ab", "pattern": "^[0-9a-fA-F]{12}$", "type": "string"}}, "deviceprofile_id": {"in": "path", "name": "deviceprofile_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "dot11_band": {"description": "802.11 Band", "in": "query", "name": "band", "schema": {"$ref": "#/components/schemas/dot11_band"}}, "dot11_proto": {"description": "a / b / g / n / ac / ax", "in": "query", "name": "proto", "schema": {"$ref": "#/components/schemas/dot11_proto"}}, "duration": {"description": "duration like 7d, 2w", "in": "query", "name": "duration", "required": false, "schema": {"default": "1d", "example": "10m", "type": "string"}}, "end": {"description": "end datetime, can be epoch or relative time like -1d, -2h; now if not specified", "in": "query", "name": "end", "schema": {"type": "integer"}}, "evpn_topology_id": {"in": "path", "name": "evpn_topology_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "fields": {"description": "list of additional fields requests, comma separeted, or `fields=*` for all of them", "in": "query", "name": "fields", "required": false, "schema": {"example": "field1,field2", "type": "string"}}, "gatewaytemplate_id": {"in": "path", "name": "gatewaytemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "guest_mac": {"in": "path", "name": "guest_mac", "required": true, "schema": {"example": "0000000000ab", "pattern": "^[0-9a-fA-F]{12}$", "type": "string"}}, "idpprofile_id": {"in": "path", "name": "idpprofile_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "image_name": {"in": "path", "name": "image_name", "required": true, "schema": {"type": "string"}}, "interval": {"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.", "in": "query", "name": "interval", "required": false, "schema": {"example": "10m", "type": "string"}}, "invite_id": {"in": "path", "name": "invite_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "ip": {"in": "query", "name": "ip_address", "required": false, "schema": {"example": "192.168.1.1", "format": "ipv4", "type": "string"}}, "limit": {"in": "query", "name": "limit", "required": false, "schema": {"default": 100, "minimum": 0, "type": "integer"}}, "map_id": {"in": "path", "name": "map_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "marvisinvite_id": {"in": "path", "name": "marvisinvite_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "metric": {"description": "see /api/v1/const/insight_metrics for available metrics", "in": "path", "name": "metric", "required": true, "schema": {"type": "string"}}, "msp_id": {"in": "path", "name": "msp_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "mxcluster_id": {"in": "path", "name": "mxcluster_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "mxedge_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listDeviceEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "mxedge_id": {"in": "path", "name": "mxedge_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "mxtunnel_id": {"in": "path", "name": "mxtunnel_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "nac_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listNacEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "naccrl_id": {"in": "path", "name": "naccrl_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, "nacportal_id": {"in": "path", "name": "nacportal_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "nacrule_id": {"in": "path", "name": "nacrule_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "nactag_id": {"in": "path", "name": "nactag_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "name": {"in": "query", "name": "name", "required": false, "schema": {"type": "string"}}, "network_id": {"in": "path", "name": "network_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "networktemplate_id": {"in": "path", "name": "networktemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "org_id": {"in": "path", "name": "org_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "orggroup_id": {"in": "path", "name": "orggroup_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "otherdevice_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listOtherDeviceEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "page": {"in": "query", "name": "page", "required": false, "schema": {"default": 1, "minimum": 1, "type": "integer"}}, "pcap_id": {"in": "path", "name": "pcap_id", "required": true, "schema": {"format": "uuid", "type": "string"}}, "psk_id": {"description": "PSK ID", "in": "path", "name": "psk_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "psk_id_query": {"description": "PSK ID", "in": "query", "name": "psk_id", "required": false, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "type": "string"}}, "pskportal_id": {"in": "path", "name": "pskportal_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "q": {"description": "search string", "in": "query", "name": "q", "schema": {"example": "search", "type": "string"}}, "resolution": {"in": "query", "name": "resolution", "schema": {"$ref": "#/components/schemas/resolution"}}, "rfdiag_id": {"in": "path", "name": "rfdiag_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "rftemplate_id": {"in": "path", "name": "rftemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "rogue_bssid": {"in": "path", "name": "rogue_bssid", "required": true, "schema": {"example": "0000000000ab", "pattern": "^[0-9a-fA-F]{12}$", "type": "string"}}, "rogue_type": {"in": "query", "name": "type", "schema": {"$ref": "#/components/schemas/rogue_type"}}, "rssizone_id": {"in": "path", "name": "rssizone_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "sdkclient_id": {"in": "path", "name": "sdkclient_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "sdkinvite_id": {"in": "path", "name": "sdkinvite_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "sdktemplate_id": {"in": "path", "name": "sdktemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "secintelprofile_id": {"in": "path", "name": "secintelprofile_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "secpolicy_id": {"in": "path", "name": "secpolicy_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "secret": {"in": "path", "name": "secret", "required": true, "schema": {"type": "string"}}, "service_id": {"in": "path", "name": "service_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "servicepolicy_id": {"in": "path", "name": "servicepolicy_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "site_id": {"in": "path", "name": "site_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "site_name": {"in": "path", "name": "site_name", "required": true, "schema": {"type": "string"}}, "sitegroup_id": {"in": "path", "name": "sitegroup_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "sitetemplate_id": {"in": "path", "name": "sitetemplate_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "sso_id": {"in": "path", "name": "sso_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "ssorole_id": {"in": "path", "name": "ssorole_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "start": {"description": "start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified", "in": "query", "name": "start", "schema": {"type": "integer"}}, "system_event_type": {"description": "see [listDeviceEventsDefinitions](/#operations/listDeviceEventsDefinitions)", "in": "query", "name": "type", "schema": {"type": "string"}}, "template_id": {"in": "path", "name": "template_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "ticket_id": {"in": "path", "name": "ticket_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "token": {"in": "path", "name": "token", "required": true, "schema": {"type": "string"}}, "uisetting_id": {"in": "path", "name": "uisetting_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "upgrade_id": {"in": "path", "name": "upgrade_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "usermac_id": {"in": "path", "name": "usermac_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "vbeacon_id": {"in": "path", "name": "vbeacon_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "vpn_id": {"in": "path", "name": "vpn_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "webhook_id": {"in": "path", "name": "webhook_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "wlan_id": {"in": "path", "name": "wlan_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "wxrule_id": {"in": "path", "name": "wxrule_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "wxtag_id": {"in": "path", "name": "wxtag_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "wxtunnel_id": {"in": "path", "name": "wxtunnel_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "zone_id": {"in": "path", "name": "zone_id", "required": true, "schema": {"example": "000000ab-00ab-00ab-00ab-0000000000ab", "format": "uuid", "type": "string"}}, "zone_type": {"in": "path", "name": "zone_type", "required": true, "schema": {"$ref": "#/components/schemas/zone_type"}}}}}