Tools (777)

Extracted live via the executor SDK.

• admin.registerNewAdmin

  Register a new admin and his/her org An email will also be sent to the user with a link to https://manage.mist.com/verify/register?token=:token

• admin.verifyAdminInvite

  Note: another call to GET /api/v1/self is required to see the new set of privileges

• admin.verifyRegistration

  Verify registration

• apiToken.createApiToken

  Create API Token Note that the key is only available during creation time.

• apiToken.deleteApiToken

  Delete an API Token

• apiToken.getApiTokens

  List Current API Tokens

• constants.getAlarmDefinitions

  Get brief definitions of all the supported alarm types. The example field contains an example payload as you would recieve in the alarm webhook output.

• constants.getApChannels

  Get List of Available channels per country code

• constants.getApLedDefinition

  Get AP LED definition

• constants.getApplications

  Get a list of applications that Juniper-Mist APs recognize

• constants.getCallEventsDefinitions

  Get Call Event Definitions

• constants.getClientEventsDefinitions

  Get List of available Client Events

• constants.getCountryCodes

  Get List of available Country Codes

• constants.getDeviceEventsDefinitions

  Get list of device events

• constants.getDeviceModels

  Get a list of AP device models for the Mist Site

• constants.getGetawayDefaultConfig

  Generate Default Gateway Config

• constants.getMxEdgeEventsDefinitions

  Get List of available MX Edge Events

• constants.getMxEdgeModels

  get available Mx Edge models

• constants.getSiteAvailableInsightMetrics

  Get Available Insight Metrics

• constants.getSiteLanguages

  Get Languages

• constants.getSystemEventsDefinitions

  Get list of available system events

• constants.getTrafficTypes

  Get List of identified traffic

• installer.addInstallerDeviceImage

  Add image

• installer.claimInstallerDevices

  This mirrors POST /api/v1/orgs/{org_id}/inventory (see Inventory API)

• installer.createInstallerMap

  Create a MAP

• installer.createOrUpdateInstallerSites

  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.

• installer.deleteInstallerDeviceImage

  delete image

• installer.deleteInstallerMap

  Delete Map

• installer.getInstallerAlarmTemplates

  Get the list of alarm templates

• installer.getInstallerDeviceProfilesWip

  Get Device Profiles

• installer.getInstallerListOfRenctlyClaimedDevices

  Get recently claimed devices

• installer.getInstallerMaps

  Get Maps

• installer.getInstallerRfTemplatesNames

  Get RF Template

• installer.getInstallerSecPolicies

  Get Secuity Policies

• installer.getInstallerSiteGroups

  Get Site Groups

• installer.getInstallerSites

  Get Sites

• installer.importInstallerMap

  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

• installer.optimizeInstallerRrm

  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’s automatically scheduled.

• installer.provisionInstallerDevices

  Provision or Replace a device

  If 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.

• installer.startInstallerLocateDevice

  Locate a Device by blinking it’s LED, it’s a persisted state that has to be stopped by calling Stop Locating API

• installer.stopInstallerLocateDevice

  Stop it

• installer.unassignInstallerRecentlyClaimedDevice

  Unassign recently claimed devices

• installer.updateInstallerMap

  Update map

• login.logout

  Logout

• login.lookup

  Login Lookup

• login.postOperation

  Log in with email/password

• loginWithOAuth2.getOAuth2AuthorizationUrlForLogin

  Obtain Authorization URL for Login

• loginWithOAuth2.getOAuth2UrlForLinking

  Obtain Authorization URL for Linking

• loginWithOAuth2.linkOAuth2MistAccount

  Link Mist account with an OAuth2 Provider

• loginWithOAuth2.loginOAuth2

  Login via OAuth2

• loginWithOAuth2.twoFactor

  Send 2FA Code

• loginWithOAuth2.unlinkOAuth2Provider

  Unlink OAuth2 Provider

• mobile.activateSdkInvite

  Verify secret

• msps.createMsp

  Create MSP account

• msps.deleteMsp

  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

• msps.updateMsp

  Update MSP

• mspsAdmins.getMspAdmin

  Get MSP Admins

• mspsAdmins.getMspAdmins

  Get MSP Admins

• mspsAdmins.getMspDetails

  Get MSP Detail

• mspsAdmins.revokeMspAdmin

  This removes all privileges this admin has against the MSP. This goes deep all the way to the sites

• mspsAdmins.updateMspAdmin

  Update MSP Admin

• mspsInventory.getMspInventoryByMac

  Get Inventoy By device MAC address

• mspsInvites.inviteMspAdmin

  Invite MSP Admin

  Note: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token

• mspsInvites.uninviteMspAdmin

  Delete admin invite

• mspsInvites.updateMspAdminInvite

  Update MSP admin invite

• mspsLicenses.claimMspLicence

  Claim an Order by Activation Code

• mspsLicenses.getMspLicenses

  Get Msp Licenses

• mspsLicenses.moveOrDeleteMspLicenseToAnotherOrg

  Move or Delete MSP Licenses

• mspsLogo.deleteMspLogo

  Delete MSP Logo

• mspsLogo.postMspLogo

  Upload Logo (only for advanced msp tier)

• mspsLogs.countMspLogs

  Count by Distinct Attributes of Audit Logs

• mspsLogs.getMspLogs

  Get a list of change logs for the current MSP

• mspsOrgGroups.createMspOrgGroup

  Create MSP Org Group

• mspsOrgGroups.deleteMspOrgGroup

  Delete MSP Org Group

• mspsOrgGroups.getMspOrgGroup

  Get MSP Org Group Details

• mspsOrgGroups.getMspOrgGroups

  Get MSP Org Groups

• mspsOrgGroups.updateMspOrgGroup

  Update MSP Org Group

• mspsOrgs.createMspOrg

  Create an Org under MSP

• mspsOrgs.getMspOrg

  Get MSP Org Details

• mspsOrgs.getMspOrgs

  Get MSP Orgs

• mspsOrgs.manageMspOrgs

  Assign or Unassign Orgs to an MSP account

• mspsOrgs.searchMspOrgs

  Search Org in MSP

• mspsSearch.searchMspOrgGroup

  Search in MSP Orgs

• mspsSlEs.getMspSle

  Get MSP SLEs (all/worst Orgs ...)

• mspsSso.createMspSso

  Create MSP SSO profile

• mspsSso.deleteMspSso

  Delete MSP SSO Config

• mspsSso.downloadMspSsoSamlMetadata

  Download MSP SSO SAML Metadata

  Example of metadata.xml:

  xml

  <?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#">    <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">        <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" />        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>        <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"/>        <md:AttributeConsumingService index="0">            <md:ServiceName xml:lang="en-US">Mist</md:ServiceName>            <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/>            <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>            <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>        </md:AttributeConsumingService>    </md:SPSSODescriptor></md:EntityDescriptor>

• mspsSso.getMspSso

  Get MSP SSO Config

• mspsSso.getMspSsoLatestFailures

  Get MSP SSO Latest Failures

• mspsSso.getMspSsoSamlMetadata

  Get MSP SSO SAML Metadata

• mspsSso.updateMspSso

  Update MSP SSO config

• mspsSsoRoles.createMspSsoRole

  Create MSP Role

• mspsSsoRoles.deleteMspSsoRole

  Delete MSP SSO Roles

• mspsSsoRoles.getMspSsoRoles

  Get MSP SSO Roles

• mspsSsoRoles.updateMspSsoRole

  Update SSO Role

• mspsStats.getMspOrgLicenses

  Get MSP Licences

• mspsStats.getMspOrgStats

  Get MSP Orgs Stats

• mspsTickets.countMspTickets

  Count tickets

• mspsTickets.getMspTickets

  Get Tickets of a MSP

• orgs.cloneOrg

  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.

• orgs.createOrg

  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 “accept” the invitation and every time the admin tries to login

• orgs.deleteOrg

  Delete Org

• orgs.getOrgInfo

  Get Organization information

• orgs.linkOrgToJuniperJuniperAccount

  Link Juniper Accounts

• orgs.unlinkOrgFromJuniperCustomerId

  Unlink Juniper Customer ID

• orgs.updateOrg

  Update Org

• orgs128T.getOrg128TRegistrationCommands

  128T devices can be managed/adopted by Mist.

• orgsAdmins.getOrgAdmins

  Get a list of people who can manage the Site/Org under the Org

• orgsAdmins.revokeOrgAdmin

  This removes all privileges this admin has against the org

• orgsAdmins.updateOrgAdmin

  Invite Org Admin

• orgsAlarms.ackOrgAlarm

  Ack Org Alarm

• orgsAlarms.ackOrgAllAlarms

  Ack all Org Alarms

  N.B.: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

• orgsAlarms.countOrgAlarms

  Count Org Alarms

• orgsAlarms.multiAckOrgAlarms

  Ack multiple Org Alarms

• orgsAlarms.multiUnackOrgAlarms

  Unack multiple Org Alarms

• orgsAlarms.searchOrgAlarms

  Search Org Alarms

• orgsAlarms.unackOrgAllArlarms

  Unack all Org Alarms

  N.B.: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

• orgsAlarmTemplates.createOrgAlarmTemplate

  Available rules can be found in Orgs>Consts>getAlarmDefs

  The delivery dict is only required if different from the template delivery settings.

• orgsAlarmTemplates.deleteOrgAlarmTemplate

  Delete Org Alarm Template

• orgsAlarmTemplates.getOrgAlarmTemplate

  Get Org Alarm Template Details

• orgsAlarmTemplates.getOrgAlarmTemplates

  Get Org Alarm Templates

• orgsAlarmTemplates.suppressOrgAlarm

  In certain situations, for example, scheduled maintanance, you may want to suspend alarms to be triggered for a period of time.

• orgsAlarmTemplates.updateOrgAlarmTemplate

  Update Org Alarm Template

• orgsApiTokens.createOrgApiToken

  Create Org API Token Note that the token key is only available during creation time.

• orgsApiTokens.deleteOrgApiToken

  Delete Org API Token

• orgsApiTokens.getOrgApiToken

  Get Org API Token

• orgsApiTokens.getOrgApiTokens

  get organization api tokens

• orgsApiTokens.updateOrgApiToken

  Update Org API Token

• orgsApTemplates.createOrgAptemplate

  Create Org AP Template

• orgsApTemplates.deleteOrgAptemplate

  Delete existing AP Template

• orgsApTemplates.getOrgAptemplate

  Get AP Template

• orgsApTemplates.getOrgAptemplates

  Get AP Templates

• orgsApTemplates.updateOrgAptemplate

  Update AP Template

• orgsAssetFilters.createOrgAssetFilters

  Create Asset Filter

  Creates 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 ‘AND’).

• orgsAssetFilters.deleteOrgAssetFilter

  Deletes an existing BLE asset filter for the given site.

• orgsAssetFilters.getOrgAssetFilter

  Get Org Asset Filter Details

• orgsAssetFilters.getOrgAssetFilters

  Get the list of all BLE asset filters for the given site. Each asset filter in the list operates independently. For a filter object to match an asset, all of the filter properties must match (logical ‘AND’ of each filter property). For example, the “Visitor Tags” filter below will match an asset when both the “ibeacon_uuid” and “ibeacon_major” properties match the asset. All non-matching assets are ignored.

• orgsAssetFilters.updateOrgAssetFilters

  Updates an existing BLE asset filter for the given site.

• orgsAssets.countOrgAssetsByDistanceField

  Count Org Assets

• orgsAssets.createOrgAsset

  Create Org Asset

• orgsAssets.deleteOrgAsset

  Delete Org Asset

• orgsAssets.getOrgAsset

  Get Org Asset Details

• orgsAssets.getOrgAssets

  Get Org Assets

• orgsAssets.importOrgAssets

  Impert Org Assets.

  It can be done via a CSV file or a JSON payload.

  CSV File Format

  csv

  name,mac"asset_name",5c5b53010101

• orgsAssets.searchOrgAssets

  Search for Org Assets

• orgsAssets.updateOrgAsset

  Update Org Asset

• orgsCalls.countOrgCallEvents

  Count Org Call Events

• orgsCalls.searchOrgCallEvents

  Search Org Call Events

• orgsCert.clearOrgCertificates

  Clear Org Certificates

• orgsCert.getOrgCertificates

  Get Org Certificates

• orgsCert.truncateOrgCrlFile

  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

• orgsClaim.claimOrgLicense

  Claim Org licenses / activation codes

• orgsClients.countOrgClientsWired

  Count by Distinct Attributes of Clients

  Note: For list of avaialable type values, please refer to getClientEventsDefinitions

• orgsClients.countOrgClientsWireless

  Count Org Wireless Clients

• orgsClients.countOrgWirelessClientsSessions

  Count Org Wireless Clients Sessions

• orgsClients.searchOrgClientsEvents

  Get Org Clients Events

• orgsClients.searchOrgClientsWired

  Search for Wired Clients in org

  Note: For list of avaialable type values, please refer to getClientEventsDefinitions

• orgsClients.searchOrgClientsWireless

  Search Org Wireless Clients

• orgsClients.searchOrgClientWirelessSessions

  Search Org Wireless Clients Sessions

• orgsCrl.getOrgCrlFile

  Get Org CRL File

• orgsDeviceProfiles.assignOrgDeviceProfileToDevices

  Assign Org Device Profile to Devices

• orgsDeviceProfiles.createOrgDeviceProfiles

  Create Device Profile

• orgsDeviceProfiles.deleteOrgDeviceProfile

  Delete Org Device Profile

• orgsDeviceProfiles.getOrgDeviceProfile

  Get Org device Profile Details

• orgsDeviceProfiles.getOrgDeviceProfiles

  Get Org Device Profiles

• orgsDeviceProfiles.unassignOrgDeviceProfilesFromDevices

  Unassign Org Device Profile from Devices

• orgsDeviceProfiles.updateOrgDeviceProfile

  Update Org Device Profile

• orgsDevices.countOrgDeviceLastConfigs

  Counts the number of entries in device config history for distinct field with given filters

• orgsDevices.countOrgDevices

  Count Org Devices

• orgsDevices.countOrgDevicesEvents

  Count Org Devices Events

• orgsDevices.getOrgApsMacs

  Get Org AP Device Mac and Radio MACs

• orgsDevices.getOrgDevices

  Get Org Devices

• orgsDevices.getOrgJuniperDevicesCommand

  Get Org Juniper Devices command

  Juniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used. A few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist.

• orgsDevices.getOrgJunosDevicesRegistrationCommands

  Junos devices running mist agents can be managed/adopted by Mist.

• orgsDevices.getOrgMultiSitesDevicesUpgrades

  get Site multi devces upgrades

• orgsDevices.getOrgMultiSitesUpgrade

  Get Multi Site Upgrade

• orgsDevices.getOrgSsrUpgradeInfo

  Get Org SSD Ugprade information

• orgsDevices.searchOrgDeviceLastConfigs

  Search Device Last Configs

• orgsDevices.searchOrgDevices

  Search Org Devices

• orgsDevices.searchOrgDevicesEvents

  Search Org Devices Events

• orgsDevices.upgradeOrgMultiSitesDevices

  Upgrade Multiple Sites

• orgsDevicesEvpn.createOrgEvpnTopology

  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.

  Notes:

  1. You can use core / distribution / access to create a CLOS topology
  2. You can also use core / distribution to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches
  3. In a small/medium campus, collapsed-core can be used where core switches are the inter-connected to do EVPN
  4. 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)

  Collapsed Core

  In 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.

  ESI-Lag

  If the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches

  Leaf / Access / Collapsed-Core

  For leaf nodes in a EVPN topology, you’d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another

• orgsDevicesEvpn.deleteOrgEvpnTopology

  Delete the Org EVPN Topology

• orgsDevicesEvpn.getOrgEvpnTolopogy

  Get One EVPN Topology Detail

• orgsDevicesEvpn.getOrgEvpnTopologies

  Get the existing EVPN topology

• orgsDevicesEvpn.updateOrgEvpnTopology

  Update the EVPN Topolgy

• orgsDevicesOthers.deleteOrgOtherDevice

  Delete OtherDevice

• orgsDevicesOthers.getOrgOtherDevice

  Get Org other device (3rd party device)

• orgsDevicesOthers.getOrgOtherDevices

  Get Org other devices (3rd party devices)

• orgsDevicesOthers.getOrgOtherDeviceStats

  Get Otherdevice Stats

• orgsDevicesOthers.setupOrgCradlepointConnectionToMist

  This sets up cradlepoint webhooks to send events to Mist

• orgsDevicesOthers.syncOrgCradlepointRouters

  This syncs cradlepoint devices with Mist. We’ll also attempt to use the LLDP data from cradlepoint to identify the linkage against Mist Site / Device

• orgsDevicesOthers.updateOrgOtherDevice

  If the Site / Device cannot be identified, a manual association can be made

• orgsDevicesOthers.updateOrgOtherDevices

  If the Site / Device cannot be identified, a manual association can be made. Either a site_id or a device_mac needs to be provided.

• orgsDevicesSsr.cancelOrgSsrUpgrade

  Best effort to cancel an upgrade. Devices which are already upgraded wont be touched↵

• orgsDevicesSsr.getOrgSsrUpgrades

  Get Org SSR Upgrades

• orgsDevicesSsr.upgradeOrgSsrs

  Upgrade Org SSRs

• orgsDevicesUtilities.countOrgBgpStats

  Count Org BGP Stats

• orgsDevicesUtilities.searchOrgBgpStats

  Search Org BGP Stats

• orgsDevicesZscaler.setupOrgZscalerCredential

  To setup Zscaler credential

• orgsGatewayTemplates.createOrgGatewayTemplate

  Create Org Gateway Template

• orgsGatewayTemplates.deleteOrgGatewayTemplate

  Delete Organization Gateway Template

• orgsGatewayTemplates.getOrgGatewayTemplate

  Get Organization Gateway Template details

• orgsGatewayTemplates.getOrgGatewayTemplates

  Get Organization Gateway Templates

• orgsGatewayTemplates.getOrgNetwork

  Get Organization Network Details

• orgsGatewayTemplates.updateOrgGatewayTemplate

  Update Organization Gateway Template

• orgsGuests.countOrgGuestAuthorizations

  Count Org Authorized Guest

• orgsGuests.deleteOrgGuestAuthorization

  Delete Guest Authorization

• orgsGuests.getOrgGuestAuthorization

  Get Guest Authorization

• orgsGuests.getOrgGuestAuthorizations

  Get Org Guest Authorizations

• orgsGuests.searchOrgGuestAuthorization

  Search Authorized Guest

• orgsGuests.updateOrgGuestAuthorization

  Update Guest Authorization

• orgsInventory.addOrgInventory

  Add Device to Org Inventory

• orgsInventory.getOrgInventory

  Get Org Inventory

  VC (Virtual-Chassis) Management

  Ideally 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

  In our implementation, we strive to achieve that without manual user configurations by

  1. during claim or adoption a VC, we require FPC0 to exist and will use its MAC as identify for the entire chassis
  2. other VC members will be automatically populated when they’re all present

  The perceivable result is

  1. from /sites/:site_id/stats/devices/:fpc0_mac API, you’d see the VC where module_stat contains the VC members
  2. from /orgs/:org_id/inventory?vc=true API, you’d see all VC members with vc_mac pointing to the FPC0
• orgsInventory.reevaluateOrgAutoAssignment

  Reevaluate Auto Assignment

• orgsInventory.replaceOrgDevices

  It’s 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’s currently in the inventory but not assigned. The Device replaced will become unassigned.

  Note: For Gateway devices only like-for-like replacements (can only replace a SRX320 with a SRX320 and not some otehr model) are allowed.

• orgsInventory.updateOrgInventoryAssignment

  Update Org Inventory

• orgsInvites.inviteOrgAdmin

  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

• orgsInvites.uninviteOrgAdmin

  Delete Admin Invite

• orgsInvites.updateOrgAdminInvite

  Update Admin Invite

• orgsJsi.adoptOrgJsiDevice

  Adopt JSI devices

• orgsJsi.createOrgJsiDeviceShellSession

  Create Shell Session

• orgsJsi.getOrgJsiDevices

  Get all devices that connected to JSI

• orgsJsi.getOrgJsiPastPurchases

  This gets all devices purchased from the accounts associated with the Org

• orgsJsi.upgradeOrgJsiDevice

  Upgrade

• orgsLicenses.getOrgLicencesBySite

  Get Licenses Usage by Sites This shows license usage (i.e. needed) based on the features enabled for the site.

• orgsLicenses.getOrgLicencesSummary

  Get the list of licenses

• orgsLicenses.moveOrDeleteOrgLicenseToAnotherOrg

  Move, Undo Move or Delete Org License to Another Org If 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:

  1. the specified license is currently active
  2. there’s enough licenses left in the specified license (by subscription_id)
  3. there will still be enough entitled licenses for the type of license after the amendment
• orgsLogs.countOrgLogsByDistinctAttributes

  Count by Distinct Attributes of Audit Logs

• orgsLogs.getOrgLogs

  Get a list of change logs for the current Org

• orgsMaps.importOrgMaps

  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

  CSV File Format

  csv

  Vendor AP name,Mist AP MacUS Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002

• orgsMarvis.troubleshootOrgClient

  Troubleshoot sites, devices, clients, and wired clients. See search APIs for device information:

  • search Device
  • search Wireless Client
  • search Wired Client

  NOTE: requires Marvis subscription license

• orgsMxClusters.createOrgMxEdgeCluster

  Create MxCluster

• orgsMxClusters.deleteOrgMxEdgeCluster

  Delete Org MXEdge Cluster

• orgsMxClusters.getOrgMxEdgeCluster

  Get Org MxEdge Cluster Details

• orgsMxClusters.getOrgMxEdgeClusters

  Get MxEdge Clusters

• orgsMxClusters.updateOrgMxEdgeCluster

  Update Org MxEdge Cluster

• orgsMxEdges.assignOrgMxEdgeToSite

  Assign Org MxEdge to Site

• orgsMxEdges.bounceOrgMxEdgeDataPorts

  Bounce TunTerm Data Ports

• orgsMxEdges.claimOrgMxEdge

  For a Mist Edge in default state, it will show a random claim code like 135-546-673 which you can “claim” it into your Org

• orgsMxEdges.controlOrgMxEdgeServices

  Control Services on a Mist Edge

• orgsMxEdges.createOrgMxEdge

  Create MxEdge

• orgsMxEdges.deleteOrgMxEdge

  Delete Org MxEdge

• orgsMxEdges.getOrgMxEdge

  Get Org MxEdge details

• orgsMxEdges.getOrgMxEdges

  Get Org MxEdges

• orgsMxEdges.getOrgMxEdgeUpgrade

  Get Mist Edge Upgrade

• orgsMxEdges.getOrgMxEdgeUpgradeInfo

  Get Mist Edge Upgrade Information

• orgsMxEdges.getOrgMxEdgeUpgrades

  Get Mist Edge Upgrades

• orgsMxEdges.restartOrgMxEdge

  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.

• orgsMxEdges.unassignOrgMxEdgeFromSite

  Unassign Org MxEdge from Site

• orgsMxEdges.unregisterOrgMxEdge

  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.

• orgsMxEdges.updateOrgMxEdge

  Update Org MxEdge

• orgsMxEdges.upgradeOrgMxEdge

  Upgrade MxEdge

• orgsMxEdges.upgradeOrgMxEdges

  Upgrade Mist Edges

• orgsMxEdges.uploadOrgMxEdgeSupportFiles

  Support / Upload Mist Edge support files

• orgsMxTunnels.createOrgMxTunnel

  Create MxTunnel

• orgsMxTunnels.deleteOrgMxTunnel

  Delete Org MxTunnel

• orgsMxTunnels.getOrgMxTunnel

  Get Org MxTunnel Details

• orgsMxTunnels.getOrgMxTunnels

  Get Org MxTiunnels

• orgsMxTunnels.updateOrgMxTunnel

  Update Org MxTunnel

• orgsNac.createOrgNacRule

  create Org NAC Rule

• orgsNac.createOrgNacTag

  Create Org NAC Tag

• orgsNac.deleteOrgNacRule

  Delete Org NAC Rule

• orgsNac.deleteOrgNacTag

  Delete Org NAC Tag

• orgsNac.getOrgNacRule

  Get Org NAC Rule

• orgsNac.getOrgNacRules

  get Org NAC Rules

• orgsNac.getOrgNacTag

  Get Org NAC Tag

• orgsNac.getOrgNacTags

  Get Org NAC Tags

• orgsNac.updateOrgNacRule

  Update Org NAC Rule

• orgsNac.updateOrgNacTag

  Update Org NAC Tag

• orgsNetworks.createOrgNetwork

  Create Organization Network

• orgsNetworks.deleteOrgNetwork

  Delete Organization Network

• orgsNetworks.getOrgNetworks

  Get Organization Networks

• orgsNetworks.updateOrgNetwork

  Update Organization Network

• orgsNetworkTemplates.createOrgNetworkTemplate

  Update Org Network Templates

• orgsNetworkTemplates.deleteOrgNetworkTemplate

  Delete Org Network Template

• orgsNetworkTemplates.getOrgNetworkTemplate

  Get Org Network Templates Details

• orgsNetworkTemplates.getOrgNetworkTemplates

  Get Org Network Templates

• orgsNetworkTemplates.updateOrgNetworkTemplates

  Update Org Network Template

• orgsOAuth.deleteOrgOauthAppAuthorization

  Delete Org Level OAuth Application Authorization With Mist Portal

• orgsOAuth.deleteOrgOauthAppAuthorizationDeprecated

  Kept for backward compatibility. Use /api/v1/orgs/{org_id}/setting/{app_name}/link instead.

  Delete Org Level OAuth Application Authorization With Mist Portal

• orgsOAuth.getOrgOauthAppLinkedStatus

  Get Org Level OAuth Application Linked Status

• orgsOAuth.getOrgOauthAppLinkedStatusDeprecated

  Kept for backward compatibility. Use /api/v1/orgs/{org_id}/setting/{app_name}/link instead.

  Get Org Level OAuth Application Linked Status

• orgsPremiumAnalytics.getOrgPmaDashboards

  This all the premium analytics dashboards for this Org

• orgsPskPortals.createOrgPskPortal

  Create Org Psk Portal

• orgsPskPortals.deleteOrgPskPortal

  Delete Org Psk Portal

• orgsPskPortals.getOrgPskPortal

  get Org Psk Portal Details

• orgsPskPortals.getOrgPskPortals

  get Org Psk Portals

  PSK Self-Service Portals are for

  1. WIFI users who want to connect to a WLAN with personal PSK, they’re told to connect to a URL where they can login (likely through company’s SSO) and get the WIFI Name / Passphrase - required input fields name, email so we can generate PSK
  2. PSK Admins (they don’t have access to normal Network Admin Portal)
• orgsPskPortals.updateOrgPskPortal

  update Org Psk Portal

• orgsPsks.createOrgPsk

  Create Org PSK

• orgsPsks.deleteOrgPsk

  Delete Org PSK

• orgsPsks.deleteOrgPskOldPassphrase

  Delete old_passphrase from PSK. If successful, response is same as GET, returns the PSK with old_passphrase removed.

• orgsPsks.getOrgPsk

  Get Org PSK Details

• orgsPsks.getOrgPsks

  Get Org Psks

• orgsPsks.importOrgPsks

  Import PSK from CSV file or JSON

  ## CSV File Format

  PSK Import CSV File Format:name,ssid,passphrase,usage,vlan_id,mac,max_usage,role,expire_time,notify_expiry,expiry_notification_time,notify_on_create_or_edit,emailCommon,warehouse,foryoureyesonly,single,35,a31425f31278,0,student,1618594236Justin,reception,visible,multi,1002,200,teacher,1618594236Common2,ssid,1245678-xx,single,35,a31425f31278,0,student,1618594236,true,7,true,admin@test.com

• orgsPsks.updateOrgMultiPsks

  Update multi PSKs

• orgsPsks.updateOrgPsk

  Update Org PSK

• orgsRfTemplates.createOrgRfTemplate

  Create Org RF Template

• orgsRfTemplates.deleteOrgRfTemplate

  Delete Org RF Template

• orgsRfTemplates.getOrgRfTemplate

  Get Org RF Template Details

• orgsRfTemplates.getOrgRfTemplates

  Get Org RF Template

• orgsRfTemplates.updateOrgRfTemplate

  Update Org RF Template

• orgsSdkClients.updateSdkClient

  Update SDK Client

• orgsSdkInvites.createSdkInvite

  Create SDK Invite

• orgsSdkInvites.getSdkInvite

  Get SDK Invite Details

• orgsSdkInvites.getSdkInviteQrCode

  Revoke SDK Invite

• orgsSdkInvites.getSdkInvites

  Get SDK Invites

• orgsSdkInvites.revokeSdkInvite

  Revoke SDK Invite

• orgsSdkInvites.sendSdkInviteEmail

  Send SDK Invite by Email

• orgsSdkInvites.sendSdkInviteSms

  Send SDK Invite by SMS

• orgsSdkInvites.updateSdkInvite

  Update SDK Invite

• orgsSdkTemplates.createSdkTemplate

  Create SDK Template

• orgsSdkTemplates.deleteSdkTemplate

  Delete SDK Template

• orgsSdkTemplates.getSdkTemplate

  Get SDK Template Details

• orgsSdkTemplates.getSdkTemplates

  Get SDK Templates

• orgsSdkTemplates.updateSdkTemplate

  Update SDK Template

• orgsSecPolicies.createOrgSecPolicies

  Create Org Security Policy

• orgsSecPolicies.deleteOrgSecPolicy

  Delete Org Security Policy

• orgsSecPolicies.getOrgSecPolicies

  Get Org Security Policies

• orgsSecPolicies.getOrgSecPolicy

  Get Org Security Policy

• orgsSecPolicies.updateOrgSecPolicies

  Update Org Security Policy

• orgsServicePolicies.createOrgServicePolicy

  Create Org Serrvice Policy

• orgsServicePolicies.deleteOrgServicePolicy

  Delete Org Service Policuy

• orgsServicePolicies.getOrgServicePolicies

  Get Org Service Policies

• orgsServicePolicies.getOrgServicePolicy

  Get Org Service Policy Details

• orgsServicePolicies.updateOrgServicePolicy

  Update Org Serrvice Policy

• orgsServices.createOrgService

  Create getOrgServices Service

• orgsServices.deleteOrgService

  deleteOrgService

• orgsServices.getOrgService

  Get Org Service

• orgsServices.getOrgServices

  Get Org Services

• orgsServices.updateOrgService

  update Org Service

• orgsSetting.createOrgClientsBlocklist

  Create Org Blacklist Client List.

  If there is already a blacklist, this API will replace it with the new one.

  Max number of blacklist clients is 1000.

  Retrieve the current blacklisted clients from blacklist_url under Org:Setting

• orgsSetting.deleteOrgClientsBlocklist

  Delete Org Blacklist Station Clients

• orgsSetting.getOrgSettings

  Get Org Settings

• orgsSetting.setOrgCustomBucket

  Provide Customer Bucket Name

  Setting up Custom PCAP Bucket Involves the following:

  • provide the bucket name
  • we’ll attempt to write a file MIST_TOKEN
  • you have to verify the ownership of the bucket by providing the content of the MIST_TOKEN
• orgsSetting.updateOrgSettings

  Update Org Settings

• orgsSetting.verifyOrgCustomBucket

  Verify Customer PCAP Bucket

  Note: If successful, a “VERIFIED” file will be created in the bucket

• orgsSitegroups.createOrgSiteGroup

  Create Org Site Group

• orgsSitegroups.deleteOrgSiteGroup

  Delete Org Site Group

• orgsSitegroups.getOrgSiteGroup

  Get Org Site Group

• orgsSitegroups.getOrgSiteGroups

  Get Org Site Groups

• orgsSitegroups.updateOrgSiteGroup

  Update Org Site Group

• orgsSites.countOrgSites

  Count Sites

• orgsSites.createOrgSite

  Create Org Site

• orgsSites.getOrgSites

  Get Org Sites

• orgsSites.importOrgMapToSite

  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

  Request

  "json": a JSON string describing your upload"file": a binary file

• orgsSites.searchOrgSites

  Search Sites

• orgsSiteTemplates.createOrgSiteTemplates

  Create Org Site Template

• orgsSiteTemplates.deleteOrgSiteTemplate

  Delete Org Site Template

• orgsSiteTemplates.getOrgSiteTemplate

  Get Org Site Template

• orgsSiteTemplates.getOrgSiteTemplates

  get Org Site Templates

• orgsSiteTemplates.updateOrgSiteTemplate

  Update Org Site Template

• orgsSlEs.getOrgSitesSle

  Get Org Sites SLE

• orgsSlEs.getOrgSle

  Get Org SLEs (all/worst sites, Mx Edges, ...)

• orgsSso.createOrgSso

  Create Org SSO Configuration

• orgsSso.deleteOrgSso

  Delete Org SSO Configuration

• orgsSso.downloadOrgSsoSamlMetadata

  Download Org SSO SAML Metdata

  Example of metadata.xml:

  xml

  <?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#">    <md:SPSSODescriptor AuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">        <md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://api.mist.com/api/v1/saml/5hdF5g/logout" />        <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat>        <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"/>        <md:AttributeConsumingService index="0">            <md:ServiceName xml:lang="en-US">Mist</md:ServiceName>            <md:RequestedAttribute Name="Role" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="true"/>            <md:RequestedAttribute Name="FirstName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>            <md:RequestedAttribute Name="LastName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic" isRequired="false"/>        </md:AttributeConsumingService>    </md:SPSSODescriptor></md:EntityDescriptor>

• orgsSso.getOrgSso

  Get Org SSO Configuration Details

• orgsSso.getOrgSsoLatestFailures

  Get Org SSO Latest Failures

• orgsSso.getOrgSsos

  Get Org SSO Configuration

• orgsSso.getOrgSsoSamlMetadata

  Get Org SSO SAML Metadata

• orgsSso.updateOrgSso

  Update Org SSO Configuration

• orgsSsoRoles.createOrgSsoRole

  Create Org SSO Role

• orgsSsoRoles.deleteOrgSsoRole

  Delete Org SSO Role

• orgsSsoRoles.getOrgSsoRole

  Get Org SSO Role Details

• orgsSsoRoles.getOrgSsoRoles

  Get Org SSO Roles

• orgsSsoRoles.updateOrgSsoRole

  Update Org SSO Role

• orgsStats.countOrgByDisctinctAttributesOfSwitchPorts

  Count by Distinct Attributes of Switch/Gateway Ports

• orgsStats.getOrgAssetsStats

  Get Org Assets Stats

• orgsStats.getOrgDevicesStats

  Org Devices stats This API renders some high-level device stats, pagination is assumed and returned in response header (as the response is an array)

• orgsStats.getOrgMxEdgesStats

  Get Org MxEdge Stats

• orgsStats.getOrgMxEdgeStats

  Get Org MxEdge Details Stats

• orgsStats.getOrgStats

  Get Org Stats

• orgsStatsTunnels.countOrgTunnelsStats

  Count Mist Tunnels Stats

• orgsStatsTunnels.searchOrgTunnelsStats

  Search Org Tunnels Stats

• orgsSubscriptions.subscribeOrgAlarmsReports

  Subscribe to Org Alarms/Reports Subscriptions define how Org Alarms/Reports are delivered to whom

• orgsSubscriptions.unsubscribeOrgAlarmsReports

  Unsubscribe from Org Alarms/Reports Subscriptions define how Org Alarms/Reports are delivered to whom

• orgsTemplates.cloneOrgTemplate

  Clone Org Template

• orgsTemplates.createOrgTemplate

  Create Org Template

• orgsTemplates.deleteOrgTemplate

  Delete Org Template

• orgsTemplates.getOrgTemplate

  Get Org Template Details

• orgsTemplates.getOrgTemplates

  Get Org Templates

• orgsTemplates.updateOrgTemplate

  Update Org Template

• orgsTickets.addOrgTicketComment

  Add Comment to support ticket

• orgsTickets.countOrgTickets

  Count Org Tickets

• orgsTickets.createOrgTicket

  Create a support ticket

• orgsTickets.getOrgTicket

  Get support ticket details

• orgsTickets.getOrgTickets

  Get Tickets of an Org

• orgsTickets.updateOrgTicket

  Update support ticket

• orgsVpNs.countOrgPeerPathStats

  Count Org Peer Path Statgs

• orgsVpNs.createOrgVpns

  Create Org VPN

• orgsVpNs.deleteOrgVpn

  delete Org Vpn

• orgsVpNs.getOrgsVpns

  Get Org VPNs

• orgsVpNs.getOrgVpn

  getOrgVpn

• orgsVpNs.searchOrgPeerPathStats

  Search Org Peer Path Stats

• orgsVpNs.updateOrgVpn

  update Org Vpn

• orgsWebhooks.createOrgWebhook

  Create Org Webhook

  N.B. For org webhooks, only device-events/alarms/audits/client-join/client-sessions/device-updowns/mxedge-events Infrastructure topics are supported.

• orgsWebhooks.deleteOrgWebhook

  Delete Org Webhook

• orgsWebhooks.getOrgWebhook

  Get Org Webhook Details

• orgsWebhooks.getOrgWebhooks

  Get Org Webhooks

• orgsWebhooks.updateOrgWebhook

  Update Org Webhook

• orgsWlans.createOrgWlan

  Create Org Wlan

• orgsWlans.deleteOrgWlan

  Delete Org WLAN

• orgsWlans.deleteOrgWlanPortalImage

  Delete Org WLAN Portal Image

• orgsWlans.getOrgWlan

  Get Org Wlan Detail

• orgsWlans.getOrgWlanDerived

  Get Org WLAN Derived

• orgsWlans.getOrgWlans

  Get Org Wlans

• orgsWlans.updateOrgWlan

  Update Org Wlan

• orgsWlans.updateOrgWlanPortalTemplate

  Update Org WLAN Portal Template

• orgsWlans.uploadOrgWlanPortalImage

  Upload Org WLAN Portal Image

• orgsWxRules.createOrgWxRule

  Create Org WxRule

• orgsWxRules.deleteOrgWxRule

  Delete Org WxRule

• orgsWxRules.getOrgWxRule

  Get Org WxRule Details

• orgsWxRules.getOrgWxRules

  Get Org WxRules

• orgsWxRules.getOrgWxRulesDerived

  Get Derived Org WxRule

• orgsWxRules.updateOrgWxRule

  Update Org WxRule

• orgsWxTags.createOrgWxTag

  Create WxLAN Tag

• orgsWxTags.deleteOrgWxTag

  Delete WxLAN Tag

• orgsWxTags.getOrgApplicationList

  Get Application List

• orgsWxTags.getOrgCurrentMatchingClientsOfAWxTag

  Get Current Matching Clients of a WXLAN Tag

• orgsWxTags.getOrgWxTag

  Get WxLAN Tag Details

• orgsWxTags.getOrgWxTags

  Get WxLAN Tags

• orgsWxTags.updateOrgWxTag

  Update WxLAN Tag

• orgsWxTunnels.createOrgWxTunnel

  Create Org WxAN Tunnel

• orgsWxTunnels.deleteOrgWxTunnel

  Delete Org WxLAN Tunnel

• orgsWxTunnels.getOrgWxTunnel

  Get Org WxLAN Tunnel Details

• orgsWxTunnels.getOrgWxTunnels

  Get Org WxLAN Tunnels

• orgsWxTunnels.updateOrgWxTunnel

  Update Org WxLAN Tunnel

• self.deleteSelf

  To delete ones account and every associated with it. The effects:

  the account would be deleted any orphaned Org (that only has this account as admin) will be deleted along with all data with Org (sites, wlans, devices) will be gone.

• self.generateQrCodeForVerification

  Generate QR code for verification

• self.getAlarmSubscriptions

  Get all the subscriptions

• self.getSelf

  Get Account information

• self.getSelfAuditLogs

  Audit logs records all administrative activities done by current admin across all orgs

  Get a list of change logs across all Orgs for current admin

• self.recoverPassword

  Recover Password An email will also be sent to the user with a link to https://manage.mist.com/verify/recover?token=:token

• self.updateSelf

  update Account Information

• self.updateSelfEmail

  Change Email We require the user to verify that they actually own the email address they intend to change it to.

  After 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

  Upon 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

  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.

• self.verifyRecoverPasssword

  Verify Recover Password With correct verification, the user will be authenticated. UI can then prompt for new password

• self.verifySelfEmail

  Verify Email change

• self.verifyTwoFactor

  Verify Two-factor (OTP)

  To verify two-factor authentication by using a code generated by app (e.g. Google Authenticator, Authy) or by SMS. Upon successful verification, the otp_verified will be set to true if it hasn’t already been.

• sites.deleteSite

  Delete Site

• sites.getSiteInfo

  Get Site Info

• sites.updateSiteInfo

  Update Site Info

• sitesAlarms.ackSiteAlarm

  Ack Site Alarm

• sitesAlarms.ackSiteAllAlarms

  Ack all Site Alarms

  N.B.: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

• sitesAlarms.countSiteAlarms

  Count Site Alarms

• sitesAlarms.multiAckSiteAlarms

  Ack multiple Site Alarms

• sitesAlarms.multiUnackSiteAlarms

  Unack multiple Site Alarms

• sitesAlarms.searchSiteAlarms

  Search Site Alarms

• sitesAlarms.unackSiteAlarm

  Unack Site Alarm

• sitesAlarms.unackSiteAllArlarms

  Unack all Site Alarms

  N.B.: Batch size for multiple alarm ack and unack has to be less or or equal to 1000.

• sitesAnomaly.getSiteAnomalyEvents

  Get Site Anomaly Events

• sitesAnomaly.getSiteAnomalyEventsForClient

  Get Client Anomaly Events

• sitesAnomaly.getSiteAnomalyEventsforDevice

  Get Device Anomaly Events

• sitesApplications.countSiteApps

  Count by Distinct Attributes of Applications

• sitesApplications.getSiteApps

  Get Application List

• sitesAssetFilters.createSiteAssetFilters

  Create Site Asset Filter

• sitesAssetFilters.deleteSiteAssetFilter

  Deletes an existing BLE asset filter for the given site.

• sitesAssetFilters.getSiteAssetFilter

  Get Site Asset Filter Details

• sitesAssetFilters.getSiteAssetFilters

  Get Site Asset Filters

• sitesAssetFilters.updateSiteAssetFilter

  Updates an existing BLE asset filter for the given site.

• sitesAssets.countSiteAssets

  Count Asset by distinct field

• sitesAssets.createSiteAsset

  Create Site Asset

• sitesAssets.deleteSiteAsset

  Delete Site Asset

• sitesAssets.getSiteAsset

  Get Site Asset Details

• sitesAssets.getSiteAssets

  Get Site Assets

• sitesAssets.getSiteAssetsOfInterest

  Get a list of BLE beacons that matches Asset or AssetFilter

• sitesAssets.importSiteAssets

  Impert Site Assets.

  It can be done via a CSV file or a JSON payload.

  CSV File Format

  csv

  name,mac"asset_name",5c5b53010101

• sitesAssets.searchSiteAssets

  Assets Search

• sitesAssets.updateSiteAsset

  Update Site Asset

• sitesBeacons.createSiteBeacon

  Create Site Beacon

• sitesBeacons.deleteSiteBeacons

  Delete Site Beacon

• sitesBeacons.getSiteBeacon

  Get Site Beacon Details

• sitesBeacons.getSiteBeacons

  Get Site Beacons

• sitesBeacons.updateSiteBeacons

  Update Site Beacon

• sitesCalls.countSiteCallEvents

  Count Site Call Events

• sitesCalls.countSiteCalls

  Count by Distinct Attributes of Calls

• sitesCalls.searchSiteCallEvents

  Search Site Call Events

• sitesCalls.searchSiteCalls

  Search Calls

• sitesClients.countSiteByDistinctAttributesOfClients

  Count by Distinct Attributes of Clients

• sitesClients.countSiteByDistinctAttributesOfClientSessions

  Count by Distinct Attributes of Client Sessions

• sitesClients.countSiteByDistinctAttributesOfClientsEvents

  Count by Distinct Attributes of Client-Events

• sitesClients.disconnectSiteClient

  This disconnect a client (and it’s likely to connect back)

• sitesClients.disconnectSiteMultipleClients

  To unauthorize multiple clients

• sitesClients.getSiteEventsForClient

  Get the list of events for a specific client

• sitesClients.searchSiteClientsEvents

  Get Site Clients Events

• sitesClients.searchSiteClientsWireless

  Search Wireless Clients

  NOTE: fuzzy logic can be used with ‘’, supported filters: mac, hostname, device, os, model. E.g. /clients/search?device=Mac&hostname=jerry

• sitesClients.searchSiteClientWirelessSessions

  Search Client Sessions

• sitesClients.unauthorizeSiteClient

  This unauthorize a client (if it’s a guest) and disconnect it. From the guest’s perspective, s/he will see the splash page again and go through the flow (e.g. Terms of Use) again.

• sitesClients.unauthorizeSiteMultipleClients

  This unauthorize clients (if they are guest) and disconnect them. From the guest’s perspective, they will see the splash page again and go through the flow (e.g. Terms of Use) again.

• sitesDevices.addSiteDeviceImage

  Attach up to 3 images to a device

• sitesDevices.cancelSiteDeviceUpgrade

  Best effort to cancel an upgrade. Devices which are already upgraded wont be touched

• sitesDevices.countSiteDeviceConfigHistory

  Counts the number of entries in device config history for distinct field with given filters

• sitesDevices.countSiteDeviceEvents

  Counts the number of entries in ap events history for distinct field with given filters

• sitesDevices.countSiteDeviceLastConfig

  Counts the number of entries in device config history for distinct field with given filters

• sitesDevices.countSiteDevices

  Counts the number of entries in ap events history for distinct field with given filters

• sitesDevices.createSiteDevice

  Create a device

• sitesDevices.deleteSiteDevice

  Delete Site Device

• sitesDevices.deleteSiteDeviceImage

  Delete image from a device

• sitesDevices.exportSiteDevices

  To download the exported device information

• sitesDevices.getSiteAvailableDeviceVersions

  Get Available Device Versions

• sitesDevices.getSiteDevice

  Get Device Configuration

• sitesDevices.getSiteDeviceConfigCmd

  Get Config CLI Commands For 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.

  Once 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

• sitesDevices.getSiteDevices

  Get list of devices on the site.

• sitesDevices.getSiteDevicesUpgrade

  Get all upgrades for site

• sitesDevices.getSiteDeviceZtpPassword

  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.

• sitesDevices.getSiteUpgrade

  Get Site Device Upgrade

• sitesDevices.importSiteDevices

  Import Information for Multiple Devices

  CSV format:

  csv

  mac,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.disabled5c5b53010101,"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

• sitesDevices.multiRestartSiteDevices

  Note that only the devices that are connected will be restarted.

• sitesDevices.multiUpgradeSiteDevices

  Upgrade Multiple Device

  Note: this call doesn’t guarantee the devices to be upgraded right away (they may be offline)

• sitesDevices.restartSiteDevice

  Restart / Reboot a device

• sitesDevices.searchSiteDeviceConfigHistory

  Search for entries in device config history

• sitesDevices.searchSiteDeviceLastConfigs

  Search Device Last Configs

• sitesDevices.searchSiteDevices

  Search Device

• sitesDevices.searchSiteDevicesEvents

  Search Devices Events

• sitesDevices.updateSiteDevice

  Update Device Configuration

• sitesDevices.upgradeSiteDevice

  Device Upgrade

• sitesDevices.uploadSiteDeviceSupportFile

  Support / Upload device support files

  Info Param

  Parameter	Type	Description
  process	string	Upload 1 file with output of show system processes extensive
  outbound-ssh	string	Upload 1 file that concatenates all /var/log/outbound-ssh.log* files
  messages	string	Upload 1 to 10 /var/log/messages* files
  core-dumps	string	Upload all core dump files, if any
  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, and the 3 most recent /var/log/messages files

• sitesDevicesAPs.getSiteDeviceIotPort

  Returns the current state of each enabled IoT pin configured as an output.

• sitesDevicesAPs.getSiteDeviceRadioChannels

  Get a list of allowed channels (per channel width)

• sitesDevicesAPs.reprovisionSiteAllAps

  To force all APs to reprovision itself again.

• sitesDevicesAPs.resetSiteAllApsToUseRrm

  Reset all APs in the Site to use RRM

• sitesDevicesAPs.setSiteDeviceIotPort

  Note: For each IoT pin referenced:

  • The pin must be enabled using the Device iot_config API
  • The pin must support the output direction
• sitesDevicesAPs.startSiteLocateDevice

  Locate a Device by blinking it’s LED, it’s a persisted state that has to be stopped by calling Stop Locating API

• sitesDevicesAPs.stopSiteLocateDevice

  Stop Locate a Device

• sitesDevicesAPs.zeroizeSiteFipsAllAps

  Zeroize all FIPS APs in the Site

• sitesDevicesOthers.getSiteOtherDevices

  Get Site other devices (3rd party devices)

• sitesDevicesStats.countSiteByDisctinctAttributesOfSwitchPorts

  Count by Distinct Attributes of Switch/Gateway Ports

• sitesDevicesStats.countSiteByDisctinctAttributesOPorts

  Count by Distinct Attributes of Switch/Gateway Ports

• sitesDevicesStats.getSiteAllClientsStatsByDevice

  Get wireless client stat by Device

• sitesDevicesStats.getSiteDevicesStats

  Get Site Devices Stats

• sitesDevicesStats.getSiteDeviceStats

  Get Site Device Stats Details

• sitesDevicesStats.getSiteMxEdgesStats

  Get Site MxEdges Stats

• sitesDevicesStats.getSiteMxEdgeStats

  Get One Site MxEdge Stats

• sitesDevicesStats.searchOrgSwOrGwPorts

  Search Switch / Gateway Ports

• sitesDevicesStats.searchSiteSwitchPorts

  Search Switch / Gateway Ports

• sitesDevicesStats.searchSiteSwOrGwPorts

  Search Switch / Gateway Ports

• sitesDevicesSwitches.cableTestFromSwitch

  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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  json

  {    "event": "data",    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",    "data": {        "session": "session_id",        "raw": "Interface TDR detail:\nTest status : Test successfully executed  ge-0/0/0\n"    }}

• sitesDevicesSwitches.clearAllLearnedMacsFromPortOnSwitch

  Clear all learned MAC addresses, including persistent MAC addresses, on a port.

• sitesDevicesSwitches.clearBpduErrosFromPortsOnSwitch

  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.

• sitesDevicesSwitches.deleteSiteLocalSwitchPortConfig

  Sometimes HelpDesk Admin needs to change port configs

• sitesDevicesSwitches.getSiteAdoptedSwitchesComplianceMetrics

  Get version compliance metrics for managed or monitored switches

• sitesDevicesSwitches.pollSiteSwitchStats

  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.

• sitesDevicesSwitches.portsBounceFromSwitch

  Port Bounce can be performed from the Switch.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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  json

  {    "event": "data",    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",    "data": {        "session": "session_id",        "raw": "Port bounce complete."    }}

• sitesDevicesSwitches.updateSiteLocalSwitchPortConfig

  Sometimes HelpDesk Admin needs to change port configs

• sitesDevicesSwitchesEvpn.createSiteEvpnTopology

  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.

  Notes:

  1. You can use core / distribution / access to create a CLOS topology
  2. You can also use core / distribution to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switches
  3. In a small/medium campus, collapsed-core can be used where core switches are the inter-connected to do EVPN
  4. 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)

  Collapsed Core

  In 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.

  ESI-Lag

  If the access switchess does not have EVPN support, you can take advantage of EVPN by setting up ESI-Lag on distribution switches

  Leaf / Access / Collapsed-Core

  For leaf nodes in a EVPN topology, you’d have to configure the IPs for networks that would participate in EVPN. Optionally, VRFs to isolate traffic from one tenant verus another

• sitesDevicesSwitchesEvpn.deleteSiteEvpnTopology

  Delete the site EVPN Topology

• sitesDevicesSwitchesEvpn.getSiteEvpnTolopogy

  Get One EVPN Topology Detail

• sitesDevicesSwitchesEvpn.getSiteEvpnTopologies

  Get the existing EVPN topology

• sitesDevicesSwitchesEvpn.updateSiteEvpnTopology

  Update the EVPN Topolgy

• sitesDevicesSwitchesVirtualChassis.createSiteVirtualChassis

  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.

  In 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’t have dedicated VC ports, below are procedures to automate the VC creation:

  1. Power on the switch that is choosen as the VC master first. And the powering on the other member switches.
  2. Claim or adopt all these switches under the same organization’s Inventory
  3. Assign these switches into the same Site
  4. Invoke vc command on the switch choosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.
  5. Connect the cables to the VC ports for these switches
  6. Wait for the VC to be formed. The Org’s inventory will be updated for the new VC.
• sitesDevicesSwitchesVirtualChassis.deleteSiteVirtualChassis

  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.

  For some unexpected cases that the VC is gone and disconncted, the API below could be used to change the state of VC’s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory.

• sitesDevicesSwitchesVirtualChassis.getSiteVirtualChassis

  Get VC Status

  The API returns a combined view of the VC status which includes topology and stats_

• sitesDevicesSwitchesVirtualChassis.setSiteVcPort

  Set VC port

• sitesDevicesSwitchesVirtualChassis.updateSiteVirtualChassisMember

  The VC creation and adding member switch API will update the device’s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.

  Change to use preprovisioned VC

  To 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. Member-id will be determined by the sequence of listed members.

  Notice: to configure preprovisioned VC, every member of the VC must be presented in members or the confg push will be failed.

  Add new members

  For 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.

  For EX2300 VC, adding new members requires to follow the procedures below:

  1. Powering on the new member switches and ensuring cables are not connected to any VC ports.
  2. Claim or adopt all new member switches under the VC’s organization Inventory
  3. Assign all new member switches to the same Site as the VC
  4. Invoke vc command to add switches to the VC.
  5. Connect the cables to the VC ports for these switches
  6. After a while, the Org’s Inventory shows this new switches has been added into the VC.

  Removing member switch

  To remove a member switch from the VC, following the procedures below:

  1. Ensuring the VC is connected to the cloud first
  2. Unplug the cable from the VC port of the switch
  3. Waiting for the VC state (vc_state) of this switch is changed to not-present
  4. Invoke update_vc with remove to remove this switch from the VC
  5. The Org’s Inventory shows the switch is removed.

  Please 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.

  Renumber a member switch

  When a member switch doesn’t work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported:

  1. Replace a non-fpc0 member switch
  2. Replace fpc0. When fpc0 is relaced, PAPI device config and JUNOS config will be both updated.

  For renumber to work, the following procedures are needed:

  1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present.
  2. Adding the new member switch to the VC
  3. Waiting for the VC state (vc_state) of this VC to be updated to API server
  4. Invoke vc with renumber to replace the new member switch from fpc X to
• sitesDevicesUtilities.arpFromDevice

  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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  json

  {  "event": "data",  "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",  "data": {    "session": "session_id",    "raw":    "Output": "\tMAC\t\tDEV\tVLAN\tRx Packets\t\t Rx Bytes\t\tTx Packets\t\t Tx Bytes\tFlows\tIdle sec\n-----------------------------------------------------------------------------------------------------------------------"  } }

• sitesDevicesUtilities.countSiteBgpStats

  Count BGP Stats

• sitesDevicesUtilities.createSiteDeviceSnapshot

  Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)

• sitesDevicesUtilities.pingFromDevice

  Ping from AP, Switch and SSR

  Ping 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  json

  {    "event": "data",    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",    "data": {        "session": "session_id",        "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n"    }}

• sitesDevicesUtilities.searchSiteBgpStats

  Search BGP Stats

• sitesDevicesUtilities.tracerouteFromDevice

  Traceroute 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

• sitesDevicesWanEdges.clearSiteSsrArpCache

  Clear the entire ARP cache or a subset if arguments are provided.

  Note: port_id is optional if neither vlan nor ip is specified

• sitesDevicesWanEdges.clearSiteSsrBgpRoutes

  Clear routes associated with one or all BGP neighbors

• sitesDevicesWanEdges.getSiteSsrAndSrxRoutes

  Get routes 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  show service-path
  Service    Service-route     Type              Destination  Next-Hop  Interface  Vector  Cost  Rate  Capacity        State
  Web        web-route1        service-agent     4.4.4.4      1.1.1.2     lan        red     10    1    200/3000       Up*Web        web-route1        service-agent     4.4.4.4      1.1.1.3     lan        red     10    1    200/3000       UpWeb        web-route2        service-agent     5.5.5.5      2.2.2.2     lan       blue     20    2    50/unlimited   DownLogin      <None>            BgpOverSVR        10.1.1.1     1.2.3.4     wan        red     10    3        -          UpLogin      <None>            BgpOverSVR        11.1.1.1     1.2.3.4     wan        red     10    1        -          UpApp1       <None>            Routed                -           -         -          -      -     -        -          -App1       learned-routed    Routed                -           -         -          -      -     -        -          -

• sitesDevicesWanEdges.getSiteSsrAndSrxSessions

  Get active sessions passing through 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  admin@ssr.node# show sessionsFri 2020-04-17 16:55:34 UTC
  Node: node1
  ====================================== ===== ============= =========== ========== ====== ======= ================= ========== ================= =========== ================= ========== =================== ========= ================= Session Id                             Dir   Service       Tenant      Dev Name   VLAN   Proto   Src IP            Src Port   Dest IP           Dest Port   NAT IP            NAT Port   Payload Encrypted   Timeout   Uptime====================================== ===== ============= =========== ========== ====== ======= ================= ========== ================= =========== ================= ========== =================== ========= ================= 01187fb8-765a-45e5-ae90-37d77f15e292   fwd   Internet      lanSubnet   lan           0   udp     192.168.0.28         44674   35.166.173.18          9930   96.230.191.130       19569   false                   154   0 days  0:00:28 01187fb8-765a-45e5-ae90-37d77f15e292   rev   Internet      lanSubnet   wan           0   udp     35.166.173.18         9930   96.230.191.130        19569   0.0.0.0                  0   false                   154   0 days  0:00:28 0859a4ae-bcff-4aa6-b812-79a5236a6c13   fwd   Internet      lanSubnet   lan           0   tcp     192.168.0.41         60843   17.249.171.246          443   96.230.191.130       51941   false                     2   0 days  0:00:10

• sitesDevicesWanEdges.getSiteSsrUpgrade

  Get Specific Site SSR Upgrade

• sitesDevicesWanEdges.releaseSiteSsrDhcpLease

  Releases an active DHCP lease.

• sitesDevicesWanEdges.servicePingFromSsr

  Ping from SSR

  Service 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

  json

  {    "event": "data",    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd",    "data": {        "session": "session_id",        "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n"    }}

• sitesDevicesWanEdges.testSiteSsrDnsResolution

  DNS resolutions are performed on the Device. The 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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}

  Example output from ws stream

   Router      | Hostname               | Resolved | Last Resolved        | Expiration-------------|------------------------|----------|----------------------|--------------------- test-device | xxx.yyy.net            | Y        | 2022-03-28T03:56:49Z | 2022-03-28T03:57:49Z

• sitesDevicesWanEdges.upgradeSiteSsr

  Upgrade Site SSR device

• sitesDevicesWanEdgesHa.createSiteDeviceHaCluster

  Create HA Cluster Both nodes has to be in the same site. We expect the user to configure ha_sync / ha_data port in port_configs already

  SRX cabling

  see Chassis Cluster User Guide for SRX Series Devices Here’s the recommended cabling.

  SRX300

  From 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)

  1. form cluster in UI
  2. configure ge-0/0/7,ge-1/0/7 for WAN (reth0)
  3. configure ge-0/0/2,ge-1/0/2 for ha_data
  4. configure ge-0/0/3- for LAN or additional WAN e.g.

  json

  {    "port_config": {        "ge-0/0/2,ge-1/0/2": {            "usage": "ha_data"        },        "ge-0/0/7,ge-1/0/7": {            "usage": "wan",            "redundant": true,            "reth_idx": 0,            "ip_config": {"type": "dhcp"}        },    }}

  1. connect ge-0/0/1 back to back for ha_control
  2. connect ge-0/0/2 back to back for ha_data
  3. connect both ge-0/0/7 to uplink switch to WAN and to reach Mist
  4. power up both devices
  5. it takes about 30 minutes for the cluster to form

  SRX320

  From 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)

  ZTP via ge-0/0/7

  Similar to SRX300

  ZTP via cl-1/0/0 (LTE)

  1. form cluster in UI
  2. configure cl-1/0/0, cl-3/0/0 as WAN (reth0)
  3. configure ge-0/0/2,ge-3/0/2 for ha_data
  4. same as above

  SRX340 / SRX345 / SRX380

  SRX340/SRX345 has dedicated OOB/fxp0 ports

  1. form cluster in UI
  2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0)
  3. configure ge-0/0/2,ge-5/0/2 for ha_data
  4. configure ge-0/0/3- for LAN or additional WAN
  5. connect ge-0/0/0 to uplink switch to WAN and to reach Mist
  6. connect ge-0/0/1 back-to-back for ha_control
  7. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used
  8. connect ge-0/0/3- to LAN or additional WANs

  SRX550

  ge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity

  1. connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)
  2. connect ge-0/0/1 back-to-back for ha_control
  3. connect ge-0/0/2 back-to-back for ha_data (fabric)
  4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)
  5. connect ge-0/0/4- to LAN or additional WANs

  SRX1500

  SRX1500 has, additionally, dedicated HA Control port

  1. form cluster in UI
  2. configure ge-0/0/0,ge-5/0/0 for WAN (reth0)
  3. configure ge-0/0/1,ge-5/0/1 for ha_data
  4. configure ge-0/0/2- for LAN or additional WAN
  5. connect dedicated ha_control back-to-back
  6. connect ge-0/0/0 to uplink switch to WAN and to reach Mist
  7. connect ge-0/0/1 back-to-back for ha_data
  8. connect ge-0/0/2- to LAN or additional WANs

  SRX4100

  SRX4100 has dedicated ha_control and ha_data (fabric) ports

  1. connect dedicated ha_control back-to-back
  2. connect dedicated ha_data back-to-back
  3. connect xe-0/0/0 to WAN to reach Mist
  4. connect xe-0/0/1- to LAN or additional WANs

  VSRX

  When 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

  1. connect net0 (fxp0) to WAN to reach Mist
  2. connect net1 back-to-back for ha_control
  3. connect net2 (ge-0/0/0) back-to-back for ha_data (fab0/fab1)
  4. connect net3 (ge-0/0/1) to WAN, intended to be used for reth0
  5. connect net4 (ge-0/0/2) to LAN

  SRX340/SRX345 has dedicated OOB/fxp0 ports VSRX has fxp0 as first Network Adapter, then ge-0/0/0-N

  1. connect ge-0/0/0 to WAN to reach Mist
  2. connect ge-0/0/1 back-to-back for ha_control
  3. connect ge-0/0/2 back-to-back for ha_data (fabric); or for SRX380, xe-0/0/16 if 10G SFP+ is used
  4. connect ge-0/0/3- to LAN or additional WANs

  SRX550

  ge-0/0/0 becomes OOB/fxp0 after cluster is enabled, make suenable oob_ip_config as dhcp to maintain cloud connectivity

  1. connect ge-0/0/0 to reach Mist (after cluster is fully up, this port becomes OOB/fxp0)
  2. connect ge-0/0/1 back-to-back for ha_control
  3. connect ge-0/0/2 back-to-back for ha_data (fabric)
  4. connect ge-0/0/3 to WAN (after cluster is up, intended to be used for reth0)
  5. connect ge-0/0/4- to LAN or additional WANs

  SRX1500

  SRX1500 has, additionally, dedicated HA Control port

  1. connect dedicated ha_control back-to-back
  2. connect ge-0/0/0 to WAN to reach mist
  3. connect ge-0/0/1 back-to-back for ha_data
  4. connect ge-0/0/2- to LAN or additional WANs

  SRX4100

  SRX4100 has dedicated ha_control and ha_data (fabric) ports

  1. connect dedicated ha_control back-to-back
  2. connect dedicated ha_data back-to-back
  3. connect xe-0/0/0 to WAN to reach Mist
  4. connect xe-0/0/1- to LAN or additional WANs
• sitesDevicesWanEdgesHa.deleteSiteDeviceHaCluster

  Delete HA Cluster

• sitesDevicesWanEdgesHa.swapSiteDeviceHaClusterNode

  Swap nodes on the HA Cluster

• sitesEvents.countSiteSystemEvents

  Count System Events

• sitesEvents.getSiteInterferenceEvents

  Get Interference Events

• sitesEvents.getSiteRoamingEvents

  Roaming Events data

• sitesEvents.searchSiteSystemEvents

  Search System Events

• sitesGuests.countSiteGuestAuthorizations

  Count Authorized Guest

• sitesGuests.deleteSiteGuestAuthorization

  Delete Guest Authorization

• sitesGuests.getSiteAllGuestAuthorizations

  Get Guest Authorizations

• sitesGuests.getSiteGuestAuthorization

  Get Guest Authorization

• sitesGuests.searchSiteGuestAuthorization

  Search Authorized Guest

• sitesGuests.updateSiteGuestAuthorization

  Update Guest Authorization

• sitesInsights.getSiteInsightMetrics

  Get Site Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

• sitesInsights.getSiteInsightMetricsForClient

  Get Client Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

• sitesInsights.getSiteInsightMetricsForDevice

  Get AP Insight Metrics See metrics possibilities at /api/v1/const/insight_metrics

• sitesInsights.getSiteRogueAPs

  Get Site Rogue/Neighbor APs

• sitesInsights.getSiteRogueClients

  Get Rogue Clients

• sitesLicenses.getSiteLicenseUsage

  This shows license usage (i.e. needed) based on the features enabled for the site.

• sitesLocation.clearSiteMlOverwriteForDevice

  Clear ML Overwrite for Device

• sitesLocation.clearSiteMlOverwriteForMap

  Clear ML Overwrite for Map

• sitesLocation.getSiteBeamCoverageOverview

  Get Beam Coverage Overview

• sitesLocation.getSiteDefaultPlfForModels

  Get Default PLF for Models

• sitesLocation.getSiteMachineLearningCurrentStat

  Get Machine Learning Current Stat For 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.

• sitesLocation.getSiteMachineLearningEvents

  Get Machine Learning Events

• sitesLocation.overwriteSiteMlForDevice

  Overwrite ML For Device

• sitesLocation.overwriteSiteMlForMap

  Overwrite ML For Map

• sitesLocation.resetSiteMlStatsByMap

  Reset ML Stats by Map

• sitesMaps.addSiteMapImage

  Add image map is a multipart POST which has an file (Image) and an optional json parameter

• sitesMaps.bulkAssignSiteApsToMap

  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

  1. if AP is unassigned to any Map, it gets associated with map_id
  2. Any moved APs are returned in the response
  3. If the AP is considered a locked AP, no action will be taken
• sitesMaps.clearSiteApAutoOrient

  This API is used to destroy the autoorientations of a map or subset of APs on a map.

• sitesMaps.clearSiteApAutoplacement

  This API is used to destroy the cached autoplacement locations of a map or subset of APs on a map.

• sitesMaps.createSiteMap

  Create Site Map

• sitesMaps.deleteSiteApAutoOrientation

  This API is called to force stop auto placement for a given map

• sitesMaps.deleteSiteApAutoplacement

  This API is called to force stop auto placement for a given map

• sitesMaps.deleteSiteMap

  Delete Site Map

• sitesMaps.deleteSiteMapImage

  Delete Site Map Image

• sitesMaps.getSiteApAutoPlacement

  This API is called to view the current status of auto placement for a given map.

• sitesMaps.getSiteMap

  Get Site Map Details

• sitesMaps.getSiteMaps

  Get Site Maps

• sitesMaps.importSiteMaps

  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

  CSV File Format

  csv

  Vendor AP name,Mist AP MacUS Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002

• sitesMaps.importSiteWayfindings

  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.

• sitesMaps.replaceSiteMapImage

  Replace Map Image

  This 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)

• sitesMaps.revertSiteApAutoOrient

  This API is used to revert the orientations of a map or subset of APs on a map to the state before auto orientation.

• sitesMaps.revertSiteApAutoplacement

  This API is used to revert the locations of a map or subset of APs on a map to the state before auto placement.

• sitesMaps.runSiteApAutoplacement

  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.

  List 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

• sitesMaps.startSiteApAutoOrientation

  This API is used to trigger a map for Auto orientation

• sitesMaps.updateSiteMap

  Update Site Map

• sitesMxEdges.createSiteMxEdge

  Create Site Mist Edge

• sitesMxEdges.deleteSiteMxEdge

  Delete Site Mist Edge

• sitesMxEdges.getSiteMxEdge

  get Site Mist Edge

• sitesMxEdges.getSiteMxEdges

  Get Site Mist Edges

• sitesMxEdges.updateSiteMxEdge

  Update Site Mist Edge settings

• sitesMxEdges.uploadSiteMxEdgeSupportFiles

  Support / Upload Mist Edge support files

• sitesMxTunnels.preemptSitesMxTunnel

  To preempt AP’s which are not connected to preferred peer to the preferred peer

• sitesPcaps.getSiteCapturingStatus

  Get Capturing status

• sitesPcaps.getSitePacketCaptures

  Get a list of captures

• sitesPcaps.startSitePacketCapture

  Initiate a Packet Capture

  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.

  Subscribe to Device Command outputs

  WS /api-ws/v1/stream

  json

  {    subscribe: "/sites/{site_id}/pcaps"}

  Response (Wireless/RadioTap)

  json

  {    "event": "data"    "channel": "/sites/:site_id/pcaps"    "data": {         "capture_id": "6b1be4fb-b239-44d9-9d3b-cb1ff3af1721",     "lost_messages": 0         "pcap_dict": {             "channel_frequency": 2412,             "channel": "1",             "datarate": "1.0 Mbps",             "rssi": -75,              "dst": "78:bd:bc:ca:0b:0a",             "src": "18:b8:1f:4c:91:c0",             "bssid": "18:b8:1f:4c:91:c0",             "frame_type": "Management",              "frame_subtype": "Probe Response",          "proto": "802.11",              "ap_mac": "d4:20:b0:81:99:2e",              "direction": "tx",              "timestamp": 1652246543,              "length": 416.0,             "interface": "radiotap",             "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",         },         "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAEEh7Yh5VBwCgAQAAoAEAAAAAKwBvCADAAQAAAIw7reCS2VNkAAAAABACbAmABLWuAAEAEBgAAwACAABQADoBeL28ygsKGLgfTJHAGLgfTJHAcIZ2WDlBJQAAAGQAERUACkFUVEttc1dpVlMBCIKEi5YkMEhsAwECBwZVUyABCx4gAQAjAhkAKgEEMgQMEhhgMBQBAAAPrAQBAAAPrAQBAAAPrAIMAAsFAQAbAABGBTIIAQAALRqtCR////8AAAAAAAAAAAAAAAAAAAAAAAAAAD0WAggVAAAAAAAAAAAAAAAAAAAAAAAAAH8IBAAIAAAAAEDdkwBQ8gQQSgABEBBEAAECEDsAAQMQRwAQn2481frn3KT+uGod2ERx+RAhAAtBcnJpcywgSW5jLhAjAApCR1cyMTAtNzAwECQACkJHVzIxMC03MDAQQgAKQkdXMjEwLTcwMBBUAAgABgBQ8gQAARARAA5BcnJpcyBXaXJlbGVzcxAIAAIgCBA8AAEBEEkABgA3KgABIN0JABAYAgEQHAAA3RgAUPICAQGEAAOkAAAnpAAAQkNeAGIyLwAzjakr"}

  vResponse (Wired)

  json

  {    "event": "data"    "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps"    "data": {        "capture_id": "f039b1b4-a23e-48b2-906a-0da40524de73",         "pcap_dict": {             "dst_mac": "68:ec:c5:09:2e:87",             "src_mac": "8c:3b:ad:e0:47:40",              "vlan": 1,              "src_ip": "34.224.147.117",              "dst_ip": "192.168.1.55",             "dst_port": 51635,              "src_port": 443,             "proto": "TCP",              "ap_mac": "d4:20:b0:81:99:2e",             "direction": "tx",              "timestamp": 1652247615,              "length": 159.0,              "interface": "wired",             "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",             },         "pcap_raw": "1MOyoQIABAAAAAAAAAAAAP//AAABAAAAQEx7YhMzAACfAAAAnwAAAGjsxQkuh4w7reBHQIEAAAEIAEUAAI1bLEAAKAZ/CiLgk3XAqAE3AbvJs4KpKEDwg8I+gBgADFf9AAABAQgKI5yfqiwkXTQXAwMAVKY5JopoKQrVEn0/3ld4YntctGEH/rTZuwtCvzSncFw71QJveJi9uxHs57KC8w9Apph3YvXJrmWg7M37+o+YV0KH/xmr626s5Bkhb3QhKOu+NoNEmA=="
      }}

  Stop Response (Wired/Wireless)

  json

  {    "event": "data"    "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps"    "data": {      "capture_id": "a2f7374d-6a70-41fd-8a3f-71e42573baaf",       "lost_messages": 0,      "pcap_dict": null    }}

• sitesPcaps.stopSitePacketCapture

  Stop current capture

• sitesPsks.createSitePsk

  Create Site PSK

• sitesPsks.deleteSitePsk

  Delete Site PSK

• sitesPsks.getSitePsk

  Get Site PSK Details

• sitesPsks.getSitePsks

  Get Site PSKs

• sitesPsks.importSitePsks

  Import PSK from CSV file or JSON

  CSV File Format

  csv

  PSK Import CSV File Format:name,ssid,passphrase,usage,vlan_id,macCommon,warehouse,foryoureyesonly,single,35,a31425f31278Justin,reception,visible,multi,1002

• sitesPsks.updateSitePsk

  Update Site PSK

• sitesPsks.updateSitePsks

  Update multi PSKs

• sitesRfdiags.deleteSiteRfdiagRecording

  Delete Recording

• sitesRfdiags.downloadSiteRfdiagRecording

  Download Recording Download raw_events blob

• sitesRfdiags.getSiteRfdiagRecording

  Get RF Diage Recording Details

• sitesRfdiags.getSiteSiteRfdiagRecording

  List RF Glass Recording

• sitesRfdiags.startSiteRecording

  Start RF Glass Recording

• sitesRfdiags.stopSiteRfdiagRecording

  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.

• sitesRfdiags.updateSiteRfdiagRecording

  Update Recording

• sitesRogues.countSiteRogueEvents

  Count Rogue Events

• sitesRogues.deauthSiteClientsConnectedToARogue

  Send Deauth frame to clients connected to a Rogue AP

• sitesRogues.getSiteRogueAp

  Get Rogue AP Details

• sitesRogues.searchSiteRogueEvents

  Search Rogue Events

• sitesRrm.getSiteCurrentChannelPlanning

  Get Current Channel Planning

• sitesRrm.getSiteCurrentRrmConsiderationsForAnApOnASpecificBand

  Get Current RRM Considerations for an AP on a Specific Band

• sitesRrm.getSiteRrmEvents

  Get Site RRM Events

• sitesRrm.optimizeSiteRrm

  Optimize Site RRM

• sitesRssizones.createSiteRssiZone

  Create RSSI Zone

• sitesRssizones.deleteSiteRssiZone

  Delete Site RSSI Zone

• sitesRssizones.getSiteRssiZone

  Get Site RSSI Zone details

• sitesRssizones.getSiteRssiZones

  Get RSSI Zone is RSSI-based

• sitesRssizones.updateSiteRssiZone

  Update Site RSSI Zone

• sitesSetting.createSiteClientsAllowlist

  This endpoint is to provide list of client macs for annotation as whitelist.

  Retrieve the current clients list from whitelist_url under Site:Setting

• sitesSetting.createSiteClientsBlocklist

  This endpoint is to provide list of client macs for annotation blacklist.

  Retrieve the current clients list blacklist_url under Site:Setting

• sitesSetting.createSiteWatchedStations

  This endpoint is to provide list of client macs for annotation as watched station.

  Retrieve the current clients list from watched_station_url under Site:Setting

• sitesSetting.deleteSiteClientsAllowlist

  Delete Site Whitelist Station Clients

• sitesSetting.deleteSiteClientsBlocklist

  Delete Site Blacklist Station Clients

• sitesSetting.deleteSiteWatchedStations

  Delete Site Watched Station Clients

• sitesSetting.getSiteSetting

  Get Site Settings

• sitesSetting.updateSiteSettings

  Update Site Settings

• sitesSkyatp.countSiteByDistringAttributesOfSkyatpEvents

  Count by Distinct Attributes of Skyatp Events (WIP)

• sitesSkyatp.searchSiteSkyatpEvents

  Search Skyatp Events (WIP)

• sitesSlEs.getSiteSleClassifierDetails

  Get SLE classifier details

• sitesSlEs.getSiteSleHistogram

  Get the histogram for the SLE metric

• sitesSlEs.getSiteSleImpactedApplications

  For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedAps

  For Wireless SLEs. Get list of impacted APs optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedChassis

  For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedGateways

  For WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedInterfaces

  For Wired and WAN SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedSwitches

  For Wired SLEs. Get list of impacted switches optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedWiredClients

  For Wired SLEs. Get list of impacted interfaces optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactedWirelessClients

  For Wireless SLEs. Get list of impacted wireless users optionally filtered by classifier and failure type

• sitesSlEs.getSiteSleImpactSummary

  Get impact summary counts optionally filtered by classifier and failure type

  • Wireless SLE Fields: wlan, device_type, device_os ,band, ap, server, mxedge
  • Wired SLE Fields: switch, client, vlan, interface, chassis
  • WAN SLE Fields: gateway, client, interface, chassis, peer_path, gateway_zones
• sitesSlEs.getSiteSleMetricClassifiers

  Get the list of classifiers for a specific metric

• sitesSlEs.getSiteSlesMetrics

  Get the list of metrics for the given scope

• sitesSlEs.getSiteSleSummary

  Get the summary for the SLE metric

• sitesSlEs.getSiteSleThreshold

  Get the SLE threshold

• sitesSlEs.replaceSiteSleThreshold

  Replace the SLE threshold

• sitesSlEs.updateSiteSleThreshold

  Update the SLE threshold

• sitesStats.countSiteDiscoveredSwitches

  Count Discovered Switches

• sitesStats.getSiteAssetsStats

  Get Site Assets Stats

• sitesStats.getSiteAssetStats

  Get Site Asset Details

• sitesStats.getSiteBeaconsStats

  Get Site Beacons Stats

• sitesStats.getSiteClientsStats

  Get Site All Clients Stats Details

• sitesStats.getSiteClientsStatsByMap

  Get Site Clients Stats By Map

• sitesStats.getSiteClientStats

  Get Site Client Stats Details

• sitesStats.getSiteDiscoveredAssetByMap

  Get a list of BLE beacons that we discovered (whether they’re defined as assets or not)

• sitesStats.getSiteDiscoveredAssets

  Get Discovered BLE Assets

  Get a list of Discovered Assets that doesn’t match any of the Asset / Assetfilters

• sitesStats.getSiteDiscoveredSwitchesMetrics

  Discovered switches related metrics, lists related switch system names & details if not compliant

• sitesStats.getSiteGatewayMetrics

  Get Site Gateway Metrics

• sitesStats.getSiteSdkStats

  Get Detail Stats of a SdkClient

• sitesStats.getSiteSdkStatsByMap

  Get SdkClient Stats By Map

• sitesStats.getSiteStats

  Get Site Stats

• sitesStats.getSiteUnconnectedClientStats

  Unconnected Client Location

• sitesStats.getSiteWxRulesUsage

  Get Wxlan Rule usage

• sitesStats.getSiteZonesStats

  Get Zones Stats

• sitesStats.getSiteZoneStats

  Get Detail Zone Stats

• sitesStats.searchSiteDiscoveredSwitches

  Search Discovered Switches

• sitesStats.searchSiteDiscoveredSwitchesMetrics

  Search Discovered Switch Metrics

• sitesSubscriptions.subscribeSite

  Subscribe to Site Alarms

• sitesSubscriptions.unsubscribeSite

  Unsubscribe to Site Alarms

• sitesSyntheticTests.getSiteSyntheticTestStatus

  Get Synthetic Testing Status

• sitesSyntheticTests.startSiteDeviceSyntheticTest

  Device Synthetic Test

• sitesSyntheticTests.startSiteSwitchRadiusSyntheticTest

  Ping test from the AP to confirm ‘reachability’ 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 ‘availability’.

• sitesSyntheticTests.triggerSiteSyntheticTest

  Trigger Synthetic Testing

• sitesUiSettings.createSiteCurdSettings

  CURD site UI settings

• sitesUiSettings.deleteSiteCurdSetting

  CURD site UI settings

• sitesUiSettings.getSiteCurdSetting

  CURD site UI settings

• sitesUiSettings.getSiteCurdSettings

  CURD site UI settings

• sitesUiSettings.getSiteDerivedCurdSetting

  Get both site UI settings(for_site=true) and org UI settings (for_site=false)

• sitesUiSettings.updateSiteCurdSetting

  CURD site UI settings

• sitesVBeacons.createSiteVBeacon

  Create Virtual Beacon

• sitesVBeacons.deleteSiteVBeacon

  Delete Site Virtual Beacon

• sitesVBeacons.getSiteVBeacon

  Get Site Virtual Beacon Details

• sitesVBeacons.getSiteVBeacons

  Get Site Virtual Beacons

• sitesVBeacons.updateSiteVBeacon

  Update Site Virtual Beacon

• sitesWebhooks.createSiteWebhook

  Webhook defines a webhook, modeled after github’s model.

  There is two types of webhooks:

  • webhooks (examples)
  • raw data webhooks (examples)

  Webhooks

  Webhooks 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.

  Client Raw Data Webhooks

  Raw 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).

  Client Raw Data Webhooks Topics

  Topics that correspond to client raw data for different client types.

  • asset-raw-rssi - Raw data from packets emitted by named and filtered assets
  • discovered-raw-rssi - Raw data from packets emitted by passive BLE devices
  • wifi-conn-raw - Raw data from packets emitted by connected devices
  • wifi-unconn-raw - Raw data from packets emitted by unconnected devices (passive)

  Rules for configuring client raw data webhooks

  1. 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)
  2. Only one client raw data webhook topic is allowed per http-post message to webhooks api
• sitesWebhooks.deleteSiteWebhook

  Delete Site Webhook

• sitesWebhooks.getSiteWebhook

  Get Site Webhook Details

• sitesWebhooks.getSiteWebhooks

  Get Site Webhooks

• sitesWebhooks.pingSiteWebhook

  send a Ping event to the webhook

• sitesWebhooks.updateSiteWebhook

  Update Site Webhook

• sitesWiredClients.countSiteClientsWired

  Count by Distinct Attributes of Clients

• sitesWiredClients.searchSiteClientsWired

  Search Wired Clients

• sitesWlans.createSiteWlan

  Create Site WLAN

• sitesWlans.deleteSiteWlan

  Delete Site WLAN

• sitesWlans.getSiteWlan

  Get Site WLAN

• sitesWlans.getSiteWlanDerived

  Get Wlans Derived

• sitesWlans.getSiteWlans

  Get Site WLANs

• sitesWlans.testSiteWlanTelstraSetup

  Allows validation of Telstra sms gateway credentials.

  In case of success, a text message confirming successful setup should be received. In case of error, telstra error message are returned.

• sitesWlans.testSiteWlanTwilioSetup

  Allows validation of twilio setup In case of success, a text message confirming successful setup should be received. In case of error, twilio error code and message are returned.

• sitesWlans.updateSiteWlan

  Update Site WLAN

• sitesWlans.updateSiteWlanPortalTemplate

  Update a Portal Template

• sitesWlans.uploadSiteWlanPortalImage

  Wlan Portal Image Upload

• sitesWxRules.createSiteWxRule

  Create Site WxLan Rule

• sitesWxRules.deleteSiteWxRule

  Delete Site WxLan Rule

• sitesWxRules.getSiteWxRule

  Get Site WxLan Rule Details

• sitesWxRules.getSiteWxRules

  Get Site WxLan Rules

• sitesWxRules.getSiteWxRulesDerived

  Get Site WxLan Rule Derived

• sitesWxRules.updateSiteWxRule

  Update Site WxLan Rule

• sitesWxTags.createSiteWxTag

  Create Site WxTag

• sitesWxTags.deleteSiteWxTag

  Delete Site WxTag

• sitesWxTags.getSiteApplicationList

  Get Application List

• sitesWxTags.getSiteCurrentMatchingClientsOfAWxTag

  Get Current Matching Clients of a WXLAN Tag

• sitesWxTags.getSiteWxTag

  Get Site WxTag Details

• sitesWxTags.getSiteWxTags

  Get Site WxTags

• sitesWxTags.updateSiteWxTag

  Update Site WxTag

• sitesWxTunnels.createSiteWxTunnel

  Create Site WxLan Tunnel

• sitesWxTunnels.deleteSiteWxTunnel

  Delete Site WxLan Tunnel

• sitesWxTunnels.getSiteWxTunnel

  Get Site WxLan tunnel Details

• sitesWxTunnels.getSiteWxTunnels

  Get Site WxLan Tunnels

• sitesWxTunnels.updateSiteWxTunnel

  Update Site WxLan Tunnel

• sitesZones.countSiteZoneSessions

  Count Site Zone Sessions

• sitesZones.createSiteZone

  Create Site Zone

• sitesZones.deleteSiteZone

  Delete Site Zone

• sitesZones.getSiteZone

  Get Site Zone Details

• sitesZones.getSiteZones

  Get Site Zones

• sitesZones.searchSiteZoneSessions

  Search Zone Sessions

• sitesZones.updateSiteZone

  Update Site Zone

• webhookSamples.alarms

  Webhook sample for alarm topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.assetRaw

  Webhook sample for asset_raw topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.audits

  Webhook sample for audit topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.clientJoin

  Webhook sample for client_join topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.clientSessions

  Webhook sample for client_sessions topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.deviceEvents

  Webhook sample for device_events topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.deviceUpDown

  Webhook sample for device_updowns topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.discoveredRawRssi

  Webhook sample for discovered-raw-rssi topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.location

  Webhook sample for location topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.occupancyAlerts

  Webhook sample for occupancy_alerts topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.ping

  Webhook sample for ping topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.sdkclientScanData

  Webhook sample for sdkclient_scan_data topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• webhookSamples.zone

  Webhook sample for zone topic

  Note: The server host will be your own server FQDN where the Mist Cloud is sending the webhook messages

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools