Site

A site represents a project, a deployment. For MSP, it can be as small as a coffee shop or a five-star 600-room hotel. A site contains a set of Maps, Wlans, Policies, Zones.

Wlan

Wireless LAN definition

Wlans are the wireless networks created under a site.

Base URI

/api/v1/sites/:site_id/wlans

Example

{
    "ssid": "corporate",
    "enabled": true,
    "auth": {
        "type": "psk",

        // type is psk
        "psk": "foryoureyesonly",
        "enable_mac_auth": false,
        "multi_psk_only": false,
        "pairwise": [ "wpa1-ccmp", "wpa2-tkip", "wpa1-tkip", "wpa2-ccmp", "wpa3" ],
        "wep_as_secondary_auth": false,

        // type = wep
        "keys": [ "1234567890", null, "0987654321", null ],
        "key_idx": 1

        // type = eap
        "eap_reauth": false

        // type = open
        "owe": "enabled",  // disabled (default) / enabled (transitional) / required

        // whether to enable Private WLAN
        "private_wlan": true,

        // sae anti-clogging token threshold
        "anticlog_threshold": 16,  // default: 16, range: 16-32
    },

    "dynamic_psk": {
        // dynamic_psk allows PSK to be selected at runtime depending on context (wlan/site/user/...)
        // thus following configurations are assumed (currently)
        // - PSK will come from RADIUS server if source is radius
        //   - AP sends client MAC as username ans password (i.e. `enable_mac_auth` is assumed)
        //   - AP sends BSSID:SSID as Caller-Station-ID
        //   - `auth_servers` is required
        // - PSK will come from cloud WLC if source is cloud_psks
        //   - default_psk will be used if cloud WLC is not available
        // - `multi_psk_only` and `psk` is ignored
        // - `pairwise` can only be wpa2-ccmp (for now, wpa3 support on the roadmap)
        "enabled": true

        "source": "radius",  // radius (default), cloud_psks
        "default_vlan_id": 999,
        "default_psk": "foryoureyesonly",  // 8-63 characters

        // optional, when 11r is enabled, we'll try to use the cached PMK, this can be disabled
        "force_lookup": false,  // default is false (meaning auto)
    },

    "roam_mode": "none",

    // radius-related
    "auth_servers_nas_id": "5c5b350e0101-nas",
    "auth_servers_nas_ip": "15.3.1.5",
    "auth_servers_timeout": 5,
    "auth_servers_retries": 3,
    "auth_server_selection": "ordered",
    "auth_servers": [
        {
            "host": "1.2.3.4",
            "port": 1812,
            "secret": "testing123"
        },
        {
            "host": "radius.internal",
            "port": 1812,
            "secret": "testing123"
        },
        {
            "host": "radius2",
            "port": 1812,
            "secret": "testing123",
            "keywrap_enabled": true, // enable keywrap algorithm. Default is false
            "keywrap_format": "hex", // key format: hex or ascii
            “keywrap_kek”: “1122334455", // Key encryption key
            “keywrap_mack” “1122334455", // Message Authentication Code Key
        },
    ],
    "acct_servers": [
        {
            "host": "1.2.3.4",
            "port": 1812,
            "secret": "testing123"
        },
        {
            "host": "radius2",
            "port": 1812,
            "secret": "testing123",
            "keywrap_enabled": true, // enable keywrap algorithm. Default is false
            "keywrap_format": "hex", // key format: hex or ascii
            “keywrap_kek”: “1122334455", // Key encryption key
            “keywrap_mack” “1122334455", // Message Authentication Code Key
        },
    ],
    "acct_interim_interval": 0,
    "dynamic_vlan": {
        "enabled": true,
        "type": "airespace-interface-name",
        "vlans": {
            "131": "default",
            "322": "fast,video"
        }
        "default_vlan_id": 999
        "local_vlan_ids": []
    },
    "dns_server_rewrite": {
        "enabled": true,
        "radius_groups": {
            "contractor": "172.1.1.1",
            "guest": "8.8.8.8"
        }
    },
    "coa_servers": [
        {
            "enabled": false,
            "ip": "1.2.3.4",
            "port": 3799,
            "secret": "testing456",
            "disable_event_timestamp_check": false
        }
    ],
    "radsec": {
        // this schema applies to
        //    /api/v1/orgs/:org_id/wlans
        //    /api/v1/sites/:site_id/wlans
        //    /api/v1/sites/:site_id/devices/:device_id

        "enabled": true,

        // either specify the list of radsec servers
        "server_name": "radsec.abc.com",
        "servers": [
            {
                "host": "1.1.1.1",
                "port": 1812
            },
            {
                "host": "radsec",
                "port": 1812
            }
        ],
        "idle_timeout": 60,

        // or use mxedge(s) as radsecproxy
        "use_mxedge": true,
        "coa_enabled": true,  // default is false
        "mxcluster_ids": ["572586b7-f97b-a22b-526c-8b97a3f609c4"], // to use mxclusters.radsec.proxy_hosts
        "use_site_mxedge": false,  // else, to use radsec.proxy_hosts; default is false
        "proxy_hosts": ["mxedge1.local"], // default is site.mxedge.radsec.proxy_hosts which must be a superset of all wlans[*].radsec.proxy_hosts
        // when radsec.proxy_hosts are not used, tunnel peers (org or site mxedges) are used irrespective of use_site_mxedge
    },
    "mist_nac": {
        // when enabled
        // - auth_servers ignored
        // - acct_servers ignored
        // - coa_servers ignored
        // - radsec ignored
        "enabled": true,
        "auth_servers_timeout": 5,
        "auth_servers_retries": 3,
        "fast_dot1x_timers": true,
        "acct_interim_interval": 1,
        "coa_enabled": true,
        "coa_port": 2880
        "network": "guest",
        "source_ip": "1.2.3.4", 
    },
    "airwatch": {
        "enabled": true,
        "console_url": "https://hs1.airwatchportals.com",
        "api_key": "aHhlbGxvYXNkZmFzZGZhc2Rmc2RmCg==",
        "username": "user1",
        "password": "test123"
    },
    "cisco_cwa": {
        "enabled": false,

        "allowed_subnets": [
            "63.5.3.0/24"
        ],
        "blocked_subnets": [
            "192.168.0.0/16",
            "172.16.0.0/12"
        ],
        "allowed_hostnames": [
            "snapchat.com",
            "ibm.com"
        ]
    },

    // band is deprecated and kept for backward compability. Use bands instead.
    "band": "24",
    // for a tri-band AP
    "bands": ["24", "5", "6"],
    "band_steer": true,
    "band_steer_force_band5": true,

    "rateset": {
        "24": {
            "min_rssi": 0,
            "template": "default"
            "legacy": [ "1", "2b", "5.5", "11", "6", "9", "12", "18", "24", "36", "48", "54" ],
            "ht": "00ff00ff00ff",
        },
        "5": {
            "min_rssi": -70,
            "template": "custom",
            "legacy": [ "6", "9", "12", "18", "24b", "36", "48", "54" ],
            "ht": "00ff00ff00ff",
            "vht": "03ff03ff03ff01ff",
            "he": "0fff0fff0fff0fff",
            "eht": "3fff0fff0fff03ff",
        }
    },
    // no-legacy (no 11b, copied from Cisco):
    //    2.4: 6(B), 9, 12, 18, 24, 36, 48, 54 + HT + VHT
    //    5:   6(B), 9, 12(B), 18, 24(B), 36, 48, 54 + HT + VHT

    // compatible (all, like before, default setting that Broadcom/Atheros used):
    //    2.4: 1(B), 2(B), 5.5(B), 6, 9, 11(B), 12, 18, 24, 36, 48, 54 + HT + VHT
    //    5:   6(B), 9, 12(B), 18, 24(B), 36, 48, 54 + HT + VHT

    // high-density (no 11b, no low rates):
    //    2.4: 24(B), 36, 48, 54 + HT/MCS3-7,11-15,19-23,27-31 + VHT/MCS3-9
    //    5:   24(B), 36, 48, 54 + HT/MCS3-7,11-15,19-23,27-31 + VHT/MCS3-9

    // for disable ht or vht rates (boolean)
    "disable_ht_vht_rates": true, 

    // for model supporting 11AX only
    "disable_11ax": false,

    // for Wi-Fi 7
    "disable_11be": true,  // default is false

    // if interface is all / eth0 / eth1 / eth2 / eth3, vlan can be specified
    "interface": "all",
    "vlan_enabled": false,
    "vlan_id": 3,

    // vlan pooling allows AP to place client on different VLAN using a deterministic algorithm
    "vlan_pooling": false,
    "vlan_ids": [3, 4, 5],

    // data tunnel - L2TP/IPSec tunnel
    "interface": "wxtunnel",
    "wxtunnel_id": "7dae216d-7c98-a51b-e068-dd7d477b7216",
    "wxtunnel_remote_id": "wifiguest"

    // data tunnel - Mist Tunnel
    "interface": "mxtunnel",
    "mxtunnel_ids": [ "08cd7499-5841-51c8-e663-fb16b6f3b45e" ],
    // disable the WLAN if
    "disable_when_mxtunnel_down": false,  // default is false
    // when different mxcluster is on different subnet, we'd want to disconnect clients (so they'll reconnect and get new IPs)
    "reconnect_clients_when_roaming_mxcluster": false,  // default is false

    // data tunnel = Mist Tunnel over Site MXEdges
    "interface": "site_mxedge",
    "mxtunnel_names": [ "default" ],

    // whether to hide SSID
    "hide_ssid": false,

    // other advanced options
    "dtim": 2,
    "disable_wmm": false,
    "disable_uapsd": false,
    "use_eapol_v1": false,
    "legacy_overds": false,
    "hostname_ie": false,
    // enable AP-AP keycaching via multicast
    "enable_local_keycaching": true,  // default is false
    "max_num_clients": 0,  // 0 (default is unlimited), 1-128

    // filters
    "isolation": false,
    "l2_isolation": false,
    "arp_filter": true
    "limit_bcast": false,
    "allow_mdns": false,
    "allow_ssdp": false,
    "allow_ipv6_ndp": true,
    "no_static_ip": false,
    "no_static_dns": false,
    "limit_probe_response": false,

    // by default, we'd inspect all DHCP packets and drop those unrelated to the wireless client itself
    // in the case where client is a wireless bridge (DHCP packets for other MACs will need to be forwarded), wireless_bridging can be enabled
    "enable_wireless_bridging": false,
    // if the client bridge is doing DHCP on behalf of other devices (L2-NAT), enable dhcp_tracking will cut down DHCP response packets to be forwarded to wireless
    "enable_wireless_bridging_dhcp_tracking": false,

    // when any of the following is true, this WLAN will be disabled
    // - cannot get IP
    // - cannot obtain default gateway
    // - cannot reach default gateway
    "disable_when_gateway_unreachable": false,  // default is false

    // access control,
    "block_blacklist_clients": false,

    // apply_to
    "apply_to": "site",
    "wxtag_ids": [],
    "ap_ids": [],

    // bandwidth limiting
    "wlan_limit_up_enabled": true,
    "wlan_limit_up": 10240,
    "wlan_limit_down_enabled": true,
    "wlan_limit_down": 20480,
    "client_limit_up_enabled": true,
    "client_limit_up": 512,
    "client_limit_down_enabled": true,
    "client_limit_down": 1024,

    "schedule": {
        "enabled": true,
        "hours": {
            "mon": "09:00-17:00",
            "fri": "09:00-17:00"
        }
    },

    "qos": {
        "overwrite": true,
        // same access class for all traffic
        "class": "best_effort"
    },

    "app_limit": {
        "enabled": true,
        "apps": {
            "netflix": 60,
            "dropbox": 300
        },
        "wxtag_ids": {
            "f99862d9-2726-931f-7559-3dfdf5d070d3": 30
        }
    },

    "app_qos": {
        "enabled": true,
        "apps": {
            "skype-business-voice": {
                // all optional
                "dscp": 46, // a reasonable default will be used if omitted
            },
            "skype-business-video": {
                // all optional
                "dscp": 32,
                "src_subnet": "10.2.0.0/16", // subnet filter is not required but helps AP to only inspect certain traffic (thus reducing AP load)
                "dst_subnet": "10.2.0.0/16"
            }
        },
        "others": [
            {
                "protocol": "udp",
                "src_subnet": "10.2.0.0/16",
                "dst_subnet": "10.2.0.0/16",
                "port_ranges": "80,1024-65535",
                "dscp": 32
            }
        ]
    },

    // bonjour support is draft/experimental/subject to change
    "bonjour": {
        "enabled": true,
        "services": {
            "airprint": {
                "scope": "same_map",  // same_ap, same_map, same_site (default)
            },
            "airplay": {
                "scope": "same_ap",

                // optional 
                "radius_groups": ["teachers"]
            }
        },
        "additional_vlan_ids": [80],
        // to prevent wireless clients to discover bonjour devices on the same WLAN
        "disable_local": false
    },

    “hotspot20”: {
         “enabled”: true,
         “operators”: ["google", "att"],
         “venue_name”: ”some_name”,
         "domain_name": ["mist.com"],
         "rcoi": ["5A03BA0000"],
         "nai_realms":[
          {
            "id":"mistsys.com",
            "eap_type":"tls"
          }
        ]
    },

    // whether to inject option 82 when forwarding DHCP packets
    "inject_dhcp_option_82": {
        "enabled": true,
        "circuit_id": "{{SSID}}:{{AP_MAC}}",
    },

    "max_idletime": 1800,

    "sle_excluded": false,

    "disable_v1_roam_notify": true,
    "disable_v2_roam_notify": false,

    // portal - none / password / multi
    "portal": {
        "enabled": true,
        "bypass_when_cloud_down": false,
        "auth": "multi",
        "passphrase_enabled": true,
        "passphrase_expire": none,
        "password": "let me in",
        "forward": true,
        "forward_url": "http://abc.com/promotions",
        "expire": 1440,
        "privacy": false,

        "facebook_enabled": true,
        "facebook_client_id": ...,
        "facebook_client_secret": .....,
        "facebook_email_domains": [],
        "facebook_expire": none,

        "google_enabled": true,
        "google_email_domains": ["mydomain.edu", "mydomain.org"],
        "google_expire": none,

        "amazon_enabled": false,
        "amazon_client_id": ...,
        "amazon_client_secret": .....,
        "amazon_email_domains": [],
        "amazon_expire": none,

        "microsoft_enabled": false,
        "microsoft_client_id": ....,
        "microsoft_client_secret": .....,
        "microsoft_email_domains": [],
        "microsoft_expire": none,

        "azure_enabled": true,
        "azure_tenant_id": .....,
        "azure_client_id": ....,
        "azure_client_secret": .....,
        "azure_expire": none,

        "sponsor_enabled": false,
        "sponsor_email_domains": ["reserved.net", "reserved.org"],
        "sponsors": {"sponsor1@company.com": "FirstName1 LastName1", "sponsor2@company.com": "FirstName2 LastName2"}
        "sponsor_link_validity_duration": 30,
        "sponsor_notify_all": false,
        "sponsor_expire": none,
        "predefined_sponsors_enabled": true, // will show sponsor emails as dropdown list
        "predefined_sponsors_hide_email": false, // if enabled, hides sponsor's email from list
        "sponsor_auto_approve": false,  // automatically approve guest, sponsor will receive an email and can reject the access
        "sponsor_status_notify": false, // if enabled, guest will get email about sponsor's action (approve/deny)

        "sms_enabled": true,
        "sms_provider": "twilio",
        "sms_expire": none,
        "twilio_sid":  "AC72ec6ba0ec5af30e6731c5e47abcdefgh",
        "twilio_auth_token": "af9dac44c344a875ab5d31cb7abcdefg",
        "twilio_phone_number": "+18548888888",
        "broadnet_user_id": "juniper",
        "broadnet_password": "password",
        "broadnet_sid": "string", //default is 'MIST'
        "clickatell_api_key": "string",
        "puzzel_service_id": "string",
        "puzzel_username": "string",
        "puzzel_password": "string",
        "gupshup_userid": "string",
        "gupshup_password": "string",
        "telstra_client_id": "string",
        "telstra_client_secret": "string",
        "smsglobal_api_key": "string",
        "smsglobal_api_secret": "string",

        "email_enabled": false,
        "cross_site": false,
    },
    "portal_template_url": "https://......",
    "portal_image": "https://url/to/image.png",
    "thumbnail": "https://url/to/image.png",

    // portal - external
    "portal": {
        "enabled": true,
        "auth": "external",
        "external_portal_url": "http://myportal.abc.com"
    },
    "portal_api_secret": "EIfPMOykI3lMlDdNPub2WcbqT6dNOtWwmYHAd6bY"

    // portal - sso
    "portal": {
        "enabled": true,
        "auth": "sso",
        "sso_issuer": "https://app.onelogin.com/saml/metadata/138130"
        "sso_idp_cert": "-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----",
        "sso_idp_sign_algo": "sha256",
        "sso_idp_sso_url": "https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130",
        "sso_nameid_format": "email",
        // optional
        "sso_forced_role": "desired",  // ignore any Role attributes and use this instead
        "sso_default_role": "guest" // use this role if Role attribute not returned (when sso_forced_role is not defined)
    },
    "portal_sso_url": "https://portal.mist.com/saml/be22bba7-8e22-e1cf-5185-b880816fe2cf/login"

    // portal - none / multi / external
    "portal_allowed_subnets": [
        "63.5.3.0/24"
    ],
    "portal_allowed_hostnames": [
        "snapchat.com",
        "ibm.com"
    ],
    "portal_denied_hostnames": [
        "msg.snapchat.com"
    ]
}

N.B portal_template will be forked out of wlan objects soon. To fetch portal_template, please query portal_template_url. To update portal_template, use Wlan Portal Template.

Parameters

NOTE: specifically, enable_wireless_bridging allows forwarding of DHCP response to client not associated with the AP

RADIUS

MIST NAC

AirWatch

Cisco CWA

Cisco CWA (central web authentication) required RADIUS with COA in order to work. See CWA for more details.

QoS

Bonjour

Note: bonjour settings supercedes allow_mdns

Data Tunnel

Others

Date Rates

Rate Limit

Hotspot 2.0

Guest Portal

Wlan Portal Image Upload

Upload background image for Portal

POST /api/v1/sites/:site_id/wlans/:wlan_id/portal_image

Request

A multi-part POST

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

Wlan Portal Image Delete

Delete background image for Portal

DELETE /api/v1/sites/:site_id/wlans/:wlan_id/portal_image

If image is not uploaded or is deleted, portal will use default image.

Wlan Portal Template

Portal template will be separated from Wlan object and storage of portal_template object in Wlan object will soon be deprecated

PUT /api/v1/sites/:site_id/wlans/:wlan_id/portal_template

Request

{
    "pageTitle": "Welcome",
    "message": "Please enjoy the complimentary Wifi",
    "authLabel": "Connect to WIFI with",
    "color": "#1074bc",
    "colorDark": "#0b5183",
    "colorLight": "#3589c6",
    "alignment": "left",

    "passphraseCancel": "Cancel",
    "passphraseLabel": "Passphrase",
    "passphraseError": "Invalid Passphrase",
    "passphraseMessage": "Enter the secret passphrase to access the WiFi network.",
    "passphraseSubmit": "Sign In",
    "passphraseTitle": "Sign in with Passphrase",

    "tos": true,
    "tosText": "terms of service",
    "tosAcceptLabel": "I accept the Terms of Service",
    "tosLink": "Terms of Service",
    "backLink": "Back to Sign In",
    "tosError": "Please review and accept terms of service",

    "optout": false,
    "optoutDefault": true,
    "optoutLabel": "Do not store"

    "email": true,
    "emailLabel": "Email",
    "emailError": "Please provide valid email",

    "emailCodeCancel": "I did not receive the code",
    "emailCodeFieldLabel": "Access Code",
    "emailCodeMessage": "Enter the access number that was sent to your email address.",
    "emailCodeSubmit": "Sign In",
    "emailCodeTitle": "Access Code",

    "name": true,
    "nameLabel": "Name",
    "nameError": "Please provide your name",

    "company": true,
    "companyLabel": "Company",
    "companyError": "Please provide company name",

    "field1": true,
    "field1Label": "Custom1",
    "field1Required": true,
    "field1Error": "Please provide field1",
    "field2": true,
    "field2Label": "Custom1",
    "field2Required": false,
    "field2Error": "Please provide field2",
    "field3": true,
    "field3Label": "Custom1",
    "field3Required": false,
    "field3Error": "Please provide field3",
    "field4": true,
    "field4Label": "Custom1",
    "field4Required": false,
    "field4Error": "Please provide field4",

    "requiredFieldLabel": "required",

    "signInLabel": "Sign In",

    "poweredBy": true,

    "authButtonAmazon": "Sign in with Amazon",
    "authButtonAzure": "Sign in with Azure",
    "authButtonEmail": "Sign in with Email",
    "authButtonMicrosoft": "Sign in with Microsoft",
    "authButtonPassphrase": "Sign in with Passphrase",
    "authButtonGoogle": "Sign in with Google",
    "authButtonFacebook" : "Sign in with Facebook",
    "authButtonSms": "Sign in with Text Message",

    "emailAccessDomainError": "Access is restricted by email domain",

    "smsNumberFieldLabel": "Mobile Number",
    "smsCarrierFieldLabel": "Mobile Carrier",
    "smsCarrierDefault": "Please Select",
    "smsCarrierError": "Please select a mobile carrier",
    "smsNumberSubmit": "Sign In",
    "smsNumberCancel": "Cancel",
    "smsNumberTitle": "Text Message Confirmation",
    "smsCodeMessage": "Enter the confirmation code",
    "smsCodeFieldLabel": "Confirmation Code",
    "smsCodeSubmit": "Sumbit Code",
    "smsCodeCancel": "Cancel",
    "smsCodeError": "Invalid Access Code",
    "smsCodeTitle": "Access Code",
    "smsCountryFieldLabel": "Country Code",
    "smsCountryFormat": "+1",
    "smsHaveAccessCode": "I have an access code",
    "smsValidityDuration": 5,
    "smsMessageFormat": "Code {{code}} expires in {{duration}} minutes.",
    "smsNumberError": "Invalid Mobile Number",
    "smsNumberFormat": "2125551212 (digits only)",
    "smsNumberMessage": "We will send an access code to your mobile number which you can use to "
                            "connect to the WiFi network. Message and data rates may apply.",
    "smsUsernameFormat": "username",
    "emailTitle": "Sign in with Email",
    "emailMessage": "We will email you an authentication code which you can use to connect to the WiFi network.",
    "accessCodeAlternateEmail": "Use alternate email address",
    "emailFieldLabel": "Enter your email address" ,
    "emailSubmit": "Send Access Code",
    "emailCancel": "Cancel",
    "emailCodeError": "Please provide valid alternate email",

    "authButtonSponsor": "Sign in as Guest",
    "sponsorEmailError": "Please provide valid sponsor email",
    "sponsorNameError": "Please provide sponsor name",
    "sponsorBackLink": "Go back and edit request form",
    "sponsorCancel": "Cancel",
    "sponsorEmail": "Sponsor Email",
    "sponsorName": "Sponsor Name",
    "sponsorInfoApproved": "Your request was approved by",
    "sponsorInfoDenied": "Your request was denied by",
    "sponsorInfoPending": "Your notification has been sent to",
    "sponsorsInfoApproved": "Your request was approved,
    'sponsorsInfoDenied': 'Your request was denied',
    'sponsorsInfoPending': 'Your notification has been sent to the sponsors',
    "sponsorNotePending": "Please wait for them to acknowledge.",
    "sponsorRequestAccess": "Request Wifi Access",
    "sponsorSelectEmail": "Select Sponsor",
    'sponsorsError': 'Please select a sponsor',
    "sponsorStatusApproved": "Your request was approved",
    "sponsorStatusDenied": "Your request was denied",
    "sponsorStatusPending": "Notification Sent",
    'sponsorAutoApproved': 'Your request was approved.',
    'sponsorAutoApprovedNote': "Your notification has been sent to",
    'sponsorsAutoApprovedNote': "Your notification has been sent to the sponsors.",
    "sponsorSubmit": "Notify Sponsor",


    // Email Customization
    "sponsorEmailTemplate": "<html template to replace/override default sponsor email template>",

    "privacyPolicy": false,
    "privacyPolicyText": "privacy notice content",
    "privacyPolicyAcceptLabel": "I accept the Privacy Notice",
    "privacyPolicyLink": "Privacy Notice",
    "privacyPolicyError": "Please review and accept privacy notice",
    "marketingPolicyOptIn": false,
    "marketingPolicyOptInText": "Marketing policy content",
    "marketingPolicyOptInLabel": "I wish to receive Marketing notifications",
    "marketingPolicyLink": "Marketing Policy"
}

Parameters

authLabel|string|”Connect to WiFi with” sponsorEmailTemplate|string|html template to replace/override default sponsor email template; See Sponsor Email Template for more details privacyPolicy|boolean|default is false privacyPolicyText|string|privacy notice text privacyPolicyAcceptLabel|string|prefix of the label of the link to go to /privacy_notice, privacyPolicyLink|string|label of the link to go to /privacy_notice, privacyPolicyError|string|error message when privacy notice is not accepted”, marketingPolicyOptIn|boolean| whether marketing policy optin is enabled, marketingPolicyOptInText|string| marketing policy text, marketingPolicyOptInLabel|string| label for marketing optin, marketingPolicyLink|string| label of the link to go to /marketing_policy

Sponsor Email Template

Sponsor Email Template supports following template variables:

Get Wlans Derived

GET /api/v1/sites/:site_id/wlans/derived?resolve=false&wlan_id=:wlan_id

Request

Response

[
    {
        "ssid": "Guest",
        "for_site": false,
        "template_id": "867860f2-dd82-3677-54a5-4d6b139c96ca",
        "template_name" "west coast",
        ...
    }
]

Response Definitions

Get Guests Derived

GET /api/v1/sites/:site_id/guests/derived?cross_site=false

Request

Response

[
    {
        "ssid": "Guest",
        "auth_method": "passphrase",
        "wlan_id": "867860f2-dd82-3677-54a5-4d6b139c96ca"
        ...
    }
]

To Crop Or Resize A Image

POST /api/v1/utils/resize_image

Request

A multi-part POST

"json": a JSON string
"file": a binary file

// for the JSON payload
{
    "width": 300,
    "height": 200",
    "topleft": [ 10, 50 ],
    "bottomright: [100, 100 ]
}

Test Twilio Setup

Allows validation of twilio setup

POST /api/v1/utils/test_twilio

Request

{
    "twilio_sid": "AC5f4366878d193fb4865ab151739999eb",
    "twilio_auth_token": "2135be04736a1a0a314bce432d61721a",
    "from": "+185051234567",
    "to": "+19999999999"
}

Parameters

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

Test Broadnet Setup

Allows validation of broadnet setup

POST /api/v1/utils/test_broadnet

Request

{
    "broadnet_user_id": "juniper",
    "broadnet_password": "sherlocked",
    "broadnet_sid": "MIST",
    "to": "+911122334455"
}

Parameters

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

Test Clickatell Setup

Allows validation of Clickatell setup

POST /api/v1/utils/test_clickatell

Request

{
    "clickatell_api_key": "Hk-ZWX4ZStWR29yS1pMvBQ=+",
    "to": "+911122334455"
}

Parameters

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

Test Puzzel Setup

Allows validation of puzzel setup

POST /api/v1/utils/test_puzzel

Request

{
    "puzzel_service_id": "2210",
    "puzzel_username": "puzzel",
    "puzzel_password": "sherlocked",
    "to": "+911122334455"
}

Parameters

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

Test Gupshup Setup

Allows validation of gupshup setup

POST /api/v1/utils/test_gupshup

Request

{
    "gupshup_userid": "juniper",
    "gupshup_password": "sherlocked",
    "to": "+911122334455"
}

Parameters

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

Test Telstra Setup

Allows validation of Telstra sms gateway credentials

POST /api/v1/utils/test_telstra

Request

{
    "telstra_client_id": "123456",
    "telstra_client_secret": "abcdef",
    "to": "+911122334455"
}

Parameters

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

Test SMSGlobal Setup

Allows validation of SMSGlobal sms gateway credentials

POST /api/v1/utils/test_smsglobal

Request

{
    "smsglobal_api_key": "123456",
    "smsglobal_api_secret": "abcdef",
    "to": "+911122334455"
}

Parameters

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

Map

Map definition

Maps may represent multiple floor one on top of another or just a collections of maps where the user decide to put into a single site.

Base URI

/api/v1/sites/:site_id/maps

For a map with type==’image’, use multi-part POST to insert a map as well as the image. To update attributes without updating image, PUT without the image. GET will contain an ‘url’ attribute with an URL to the image

Example

// for image map
{
    "name": "Mist Office",
    "type": "image",
    "ppm": 40.94,
    "width": 1250,
    "height": 1500,
    "origin_x": 35,
    "origin_y": 60,
    "orientation": 30,
    "locked": false,
    "wayfinding": {
        "snap_to_path": true,
        "micello": {
            "account_key": "adasdf",
            "map_id": "c660f81dd250c",
            "default_level_id": 5
        }
    },
    "wayfinding_path": {
        "coordinate": "actual",
        "nodes": [
            {
                "name": "N1",
                "position": {
                    "x": 746,
                    "y": 104
                },
                "edges": {
                    "N2": "1"
                }
            },
            {
                "name": "N2",
                "position": {
                    "x": 740,
                    "y": 318
                },
                "edges": {
                    "N1": "1",
                }
            }
        ]
    },
    "wall_path": {
        "coordinate": "actual",
        "nodes": [
            {
                "name": "N1",
                "position": {
                    "x": 746,
                    "y": 104
                },
                "edges": {
                    "N2": "1"
                }
            },
            {
                "name": "N2",
                "position": {
                    "x": 740,
                    "y": 318
                },
                "edges": {
                    "N1": "1",
                }
            }
        ]
    },
    "sitesurvey_path": [
        {
            "coordinate": "actual",
            "nodes": [
                {
                    "name": "W0",
                    "position": {
                        "x": 372,
                        "y": 192
                    },
                    "edges": {
                        "W1": 1
                    }
                },
                {
                    "name": "W1",
                    "position": {
                        "x": 485,
                        "y": 205
                    },
                    "edges": {
                        "W2": 1
                    }
                },
                {
                    "name": "W2",
                    "position": {
                        "x": 400,
                        "y": 295
                    },
                    "edges": {
                        "W0": 1
                    }
                },
            ],
            "name": "Default",
            "id": "cbdb7f0b-3be0-4872-88f9-58790b509c23-j68kows8"
        }
    ],
    "flags": {
        "assetHoldTime": 5,
        "storeTime": 10
    },
    "url": "https://url/to/image.png",
    "thumbnail_url": "https://url/to/image.png"
}

// for google map
{
    "name": "Oakridge Mall",
    "type": "google",
    "view": "roadmap",
    "origin_x": -122.033010,
    "origin_y": 37.295080,
    "latlng_tl": { "lat": 37.295057, "lng": -122.033095 },
    "latlng_br": { "lat": 37.295285, "lng": -122.032789 }
}

Parameters

Add an image map

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

POST /api/v1/sites/:site_id/maps/:map_id/image

Request

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

Delete an image map

Delete image added to the map

DELETE /api/v1/sites/:site_id/maps/:map_id/image

Map Import

Import data from files is a multipart POST which has a file, a json, and an optional csv, to create floorplan and place matching ap automatically if supported, name ap if not exists

POST /api/v1/sites/:site_id/maps/import

Request

A multi-part POST

"json": a JSON string, includes vendor options: ekahau, ibwave, import_all_floorplans: optional, false by default,
import_height: optional, default: true, import_orientation: optional, default: true
"file": a binary file, option: .esx file (ekahau)
"csv": a csv file for ap name mapping, optional
// for the JSON payload
{
    "vendor_name": "ekahau",
    "import_all_floorplans": true  // optional
    "import_height": true, // optional
    "import_orientation": false // optional
}

Device Import CSV File Format

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

Response

{
    "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",
    "aps": [
        {
            "mac": "5c5b35000001",
            // placed 
            "action": "placed" 
            "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5"
            // named and placed
            "action": "named-placed"
            // if we ignore it (did nothing with it)
            "action": "ignored",
            "reason": "not found on current site",
            // floorplan id, height, orientation for ignored ap
            "floorplan_id": "cbdb7f0b-3be0-4872-88f9-58790b509c23-j68kows8"
            "orientation": 45,
            "height": 3
        }
    ],
    "floorplans": [
        {
            // whatever ID vendor has
            "id": "cbdb7f0b-3be0-4872-88f9-58790b509c23-j68kows8",
            "name": "map1",
            "action": "imported",
            "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5"
        }
    ],
    "summary": {
        "num_ap_assigned": 1,
        "num_map_assigned": 1
    }
}

Import Micello Info

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.

POST /api/v1/sites/:site_id/maps/:map_id/wayfinding/import

Request

{
    "vendor_name": "micello",
    "account_key": "adasdf",
    "map_id": "c660f81dd250c",
    "default_level_id": 5
}

Import Jibestream Info

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.

POST /api/v1/sites/:site_id/maps/:map_id/wayfinding/import

Request

{
    "vendor_name": "jibestream",
    "venue_id": 123,
    "map_id": "123",
    "ppm": 4.479186910505666,
    "client_id": "199d6770-0f6f-407a-9bd5-fc33c7840194",
    "client_secret": "/9Nog3yDzcYj0bY91XJZQLCt+m9DXaIVhx+Ghk3ddd",
    "customer_id": 123,
    "endpoint_url": "https://api.jibestream.com",
    "mmpp": 223.2548049411735
}

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)

POST /api/v1/sites/:site_id/maps/:map_id/replace

Request

"json": a JSON string of
{
    // for a 600x400 src image, 400x200 new image
    // this means the new image is positioned at (200, 150) with the same scale, no rotation
    "transform": {
        "x": 200,
        "y": 150,
        "scale": 1.0,
        "rotate": 0
    }
}
"file": a binary file

Parameters

Bulk Assign APs to a Map

POST /api/v1/sites/:site_id/maps/:map_id/set_map

Usage

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

Request Payload

{
    "macs": [
        "5c5b35000001",
        "5c5b35584a6f"
    ]
}

Assigns the devices present in input list of devices to :map_id

Response

{
    "moved": ["5c5b35584a6f"],
    "locked": ["5c5b35000001"]
}

Zone

Zone schema

Zones are areas on a map defined by the admin for different purposes. e.g. different Wlans, occupancies, policies.

Base URI

/api/v1/sites/:site_id/zones

Example

{
    "name": "Board Room",
    "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
    "vertices": [
        { "x":1119, "y":518 },
        { "x":1393, "y":518 },
        { "x":1393, "y":740 },
        { "x":1119, "y":740 }
    ]
}

Parameters

Virtual Beacons

Virtual beacons appear to consumer of our VBLE Mobile SDK as regular BLE beacons.

Base URI

/api/v1/sites/:site_id/vbeacons

Example

{
    "uuid": "31375aeb-b8d3-1ea6-83bf-a31eb04e1c38",
    "major": 1356,
    "minor": 21,

    "power_mode": "default",
    "message": "Welcome to Mist",

    "url": "http://www.mist.com/any",
    "wayfinding_nodename": "node1",

    "name": "conference room",
    "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
    "x": 53.5,
    "y": 173.1
}

Parameters

RSSI Zone

RSSI Zone schema

RSSI Zone is RSSI-based

Base URI

/api/v1/sites/:site_id/rssizones

Example

{
    "name": "Board Room",
    "devices": [
        {
            "device_id": "00000000-0000-0000-1000-5c5b35bd76bb",
            "rssi": -80
        }
    ]
}

Parameters

Beacons

Beacons represents a physical 3rd-party beacon. The customer will need to tell us the properties of this BLE beacon. So we can use it in our locationing.

Base URI

/api/v1/sites/:site_id/beacons

Example

{
    // for iBeacon
    "type": "ibeacon",
    "ibeacon_uuid": "31375aeb-b8d3-1ea6-83bf-a31eb04e1c38",
    "ibeacon_major": 1356,
    "ibeacon_minor": 21,

    // for Eddystone using UID
    "type": "eddystone-uid",
    "eddystone_namespace": "2818e3868dec25629ede",
    "eddystone_instance": "5c5b35000001",

    // for Eddystone using URL
    "type": "eddystone-url",
    "eddystone_url": "https://www.abc.com",

    "power": 4,

    "name": "conference room",
    "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
    "x": 53.5,
    "y": 173.1,

    "mac": "c4887201b5a8",
}

Parameters

Get Beacon Stats

GET /api/v1/sites/:site_id/stats/beacons

Response

[
    {
        "mac": "c4887201b5a8",
        "name": "conference room",
        "type": "eddystone-uid",
        "eddystone_namespace": "2818e3868dec25629ede",
        "eddystone_instance": "5c5b35000001",
        "power": 4,
        "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
        "x": 53.5,
        "y": 173.1,

        "battery_voltage": 3370,
        "last_seen": 1492110810
    }
]

Asset Filters

Base URI

/api/v1/sites/:site_id/assetfilters

Example

{
    // required
    "name": "Visitor Tags",
    "disabled": false,

    // must contain at-least one of the following filter properties
    "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
    "ibeacon_major": 13,
    "eddystone_uid_namespace": "2818e3868dec25629ede",
    "eddystone_url": "https://www.abc.com",
    "mfg_company_id": 935,
    "service_uuid": "0000fe6a-0000-1000-8000-0030459b3cfb"
}

Parameters

Get Asset Filters

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.

GET /api/v1/sites/:site_id/assetfilters

Response

[
    {
        // Filter #1: each filter can contain any subset of filter properties
        "name": "Visitor Tags",
        "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
        "ibeacon_major": 13
    },
    {
        // Filter #2: each filter can contain any subset of filter properties
        "name": "Company Tags",
        "eddystone_uid_namespace": "2818e3868dec25629ede",
        "eddystone_url": "https://www.abc.com",
        "mfg_company_id": 935
    }
]

Get Single Asset Filter

Gets a single asset filter by id.

GET /api/v1/sites/:site_id/assetfilters/:filter_id

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

POST /api/v1/sites/:site_id/assetfilters

Request

{
    "name": "Visitor Tags",
    "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
    "ibeacon_major": 13,
    "eddystone_uid_namespace": "2818e3868dec25629ede",
    "eddystone_url": "https://www.abc.com",
    "mfg_company_id": 935,
    "service_uuid": "0000fe6a-0000-1000-8000-0030459b3cfb"
    "disabled": False,
}

Parameters

Response

Status: 200 OK
Status: 400 At least one filter must be specified

Update Asset Filter

Updates an existing BLE asset filter for the given site.

PUT /api/v1/sites/:site_id/assetfilters/:filter_id

Delete Asset Filter

Deletes an existing BLE asset filter for the given site.

DELETE /api/v1/sites/:site_id/assetfilters/:filter_id

Assets

Base URI

/api/v1/sites/:site_id/assets

Example

{
    "name": "Expensive Instrument",
    "mac": "a31eb04e1c38"
}

Parameters

Import assets

API will replace the assets with same mac if provided upsert=True, otherwise will report in errors in response.

POST /api/v1/sites/:sites_id/assets/import?upsert=True

Upload via CSV file

A multi-part POST

"file": CSV File

CSV File Format

name,mac
"asset_name",5c5b53010101

Upload via JSON Payload

[
    {
        "name": "Expensive Instrument",
        "mac": "a31eb04e1c38"
    },
    {
        "name": "Cheap Instrument",
        "mac": "a31eb04e1c37"
    }
]

Get Asset Stats

GET /api/v1/sites/:site_id/stats/assets

Response

[
    {
        "name": "Expensive Instrument",

        "mac": "a31eb04e1c38",

        // populated automatically
        "last_seen": 1492110810,
        "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",
        "x": 60,
        "y": 80,

        "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
        "ibeacon_major": 13,
        "ibeacon_minor": 138,
        "eddystone_uid_namespace": "2818e3868dec25629ede",
        "eddystone_uid_instance": "5c5b35000001",
        "eddystone_url_url": "https://www.abc.com",

        "battery_voltage": 3370
    }
]

Parameters

Get Detail Asset Stats

GET /api/v1/sites/:site_id/stats/assets/:asset_id

Response

{
    "name": "Expensive Instrument",

    "mac": "a31eb04e1c38",

    // populated automatically
    "last_seen": 1492110810,
    "map_id": "845a23bf-bed9-e43c-4c86-6fa474be7ae5",
    "x": 60,
    "y": 80
    "battery_voltage": 3370

    // only send this for individual asset stat
    "zones": [
        {
            "id": "8ac84899-32db-6327-334c-9b6d58544cfe",
            "since": 1428939600
        }
    ],
    "rssizones": [
        {
            "id": "b2af5d7b-c3d0-c5c9-57e9-4d740871db47",
            "since": 1428939600
        }
    ]
}

Get BLE Assets of interest

Get a list of BLE beacons that matches Asset or AssetFilter

GET /api/v1/sites/:site_id/stats/filtered_assets?duration=1d

Response

[
    {
        "mac": "5c5b350eaaaa",
        "curr_site": "67970e46-4e12-11e6-9188-0242ac11aaaa",
        "device_name": "",
        "manufacture": "Mist Systems",
        "id": "3c0c8abc-aaaa-4070-9dd0-b9a18e7ec6fa",
        "name": "asset4",
        "by": "asset",
        "last_seen": 1643837316.760462,
        "map_id": "f5d26c7f-1670-4921-a79d-09f887f4aaaa",
        "_checkpoint_preparer": 1635888509,
        "_checkpoint_scan": 1636148467,
        "_checkpoint_prep": 1636148467,
        "_timestamp": 1643837316,
        "_ttl": 86349,
        "_id": "5c5b350eaaaa",
        "ap_mac": "5c5bbbbeaaaa",
        "beam": 6,
        "rssi": -30
    }
]

Get Discovered BLE Assets

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

GET /api/v1/sites/:site_id/stats/discovered_assets

Get Discovered BLE Assets by Map

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

GET /api/v1/sites/:site_id/stats/maps/:map_id/discovered_assets

Response

[
    {
        "mac": "6fa474be7ae5",
        "device_name": "[TV] UN65JU670D",
        "x": 60,
        "y": 80,
        "manufacture": "Apple",
        "last_seen": 1428939600,

        // optionally populated
        "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
        "ibeacon_major": 13,
        "ibeacon_minor": 138,
        "eddystone_uid_namespace": "2818e3868dec25629ede",
        "eddystone_uid_instance": "5c5b35000001",
        "eddystone_url_url": "https://www.abc.com",
        "mfg_company_id": 935,
        "mfg_data": "648520a1020000",
        "duration": 120

    }
]

Definitions

Assets Search

GET /api/v1/sites/:site_id/stats/assets/search
GET /api/v1/sites/:site_id/stats/assets/search?mac='fbc721cc3022'

Parameters

Response

{
    "results": [
        {
            "battery_voltage": "283",
            "eddystone_uid_namespace": "f7826da6bc5b71e0893e",
            "last_seen": 1633971808,
            "eddystone_uid_instance": "424c43527039",
            "eddystone_url": "eddystone_url",
            "mac": "fbc721cc3022",
            "manufacture": "Unknown",
            "timestamp": 1633971808667,
            "map_id": "map_id",
            "org_id": "org_id",
            "by": "assetfilter",
            "site_id": "site_id",
            "name": "name",
            "temperature": "0.0",
            "ap_mac": "fbc721ccaaaa",
            "rssi": -30,
            "beam": "7"
        },
    ],
    "start": 1633367108.3799882,
    "end": 1633971908.3799632,
    "limit": 100,
    "total": 1
}

Count Asset by distinct field

GET /api/v1/sites/:site_id/stats/assets/count     
GET /api/v1/sites/:site_id/stats/assets/count?distinct=ibeacon_uuid

Parameters

Response

{
    "results": [
        {
            "site_id": "site_id",
            "count": 19
        }
    ],
    "start": 1633368208.7445683,
    "end": 1633973008.7445416,
    "limit": 100,
    "distinct": "site_id",
    "total": 1,
}

Subscribe to Discovered BLE Assets Stream

WS /api-ws/v1/stream

Request

{
    "subscribe": "/sites/:site_id/stats/maps/:map_id/discovered_assets"
}

Response

{
    "event": "data",
    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/stats/maps/63eda950-c6da-11e4-a628-60f81dd250cc/discovered_assets",
    "data": {
         "mac": "4a0222000e31",
         "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
         "x": 51.0,
         "y": 29.0,
         "manufacture": "Unknown",
         "last_seen": 1480716946
    }
}

Subscribe to BLE Assets Stream

WS /api-ws/v1/stream

Request

{
    "subscribe": "/sites/:site_id/stats/maps/:map_id/assets"
}

Response

{
    "event": "data",
    "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/stats/maps/63eda950-c6da-11e4-a628-60f81dd250cc/assets",
    "data": {
         "mac": "4a0222000e31",
         "x": 51.0,
         "y": 29.0,
         "last_seen": 1480716946
    }
}

## Subscribe to MxEdges Stream

 WS /api-ws/v1/stream

### Request

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

### Response

{ "event": "data", "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/mxedges", "data": { "device_id": "00000000-0000-0000-1000-5c5b3524500b", "event_type": "fwupdate", "detail": { "timestamp": 1485381027, "status": "inprogress", "progress": 45 } } }

### Definition

Subscribe to streaming PCAP

WS /api-ws/v1/stream

Request

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

Response (Wireless/RadioTap)

{
    "event": "data"
    "channel": "/sites/:site_id/pcaps"
    "data": {
         "capture_id": "6b1be4fb-b239-44d9-9d3b-cb1ff3af1721"
         "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\"

}

Response (Wired)

{
    "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)

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

Definitions

PSK

Base URI

/api/v1/sites/:site_id/psks

Add PSK

Add psk on the site. Required: ssid, passphrase.

POST /api/v1/sites/:site_id/psks

Get PSK

Get list of psks on the site. If provided, name or ssid or role query param, psks with exact name/ssid/role match will be returned.

GET /api/v1/sites/:site_id/psks?name=Common

Example

{
    "name": "Common",
    "passphrase": "foryoureyesonly",
    "ssid": "warehouse",
    "usage": "single",
    "vlan_id": 417,            // optional
    "mac": "5684dae9ac8b",     // optional
    "expire_time": 1614990263  // optional, epoch time in seconds, default is null, as no expiration  
    "notes": "notes"           // optional
    "notify_expiry": true      // optional
    "expiry_notification_time": 2      // optional, unit days
    "notify_on_create_or_edit": true   // optional
    "email": "admin@test.com"  // email to send psk expiring notifications to
}

Definitions

Delete PSK

Delete psks on site. If provided, name or ssid param, psks with exact name/ssid match will be deleted.

DELETE /api/v1/sites/:site_id/psks?ssid=warehouse

Update multi PSKs

PUT /api/v1/sites/:site_id/psks

Example

[
    {
         "id": "2f64a022-9422-4fa3-92aa-ff6559a9f7f9", //psk_id, required
         "name": "common123",
    },
    {
        "id": "110c59ae-d7b2-40f9-9bf2-82367370e55a", //psk_id, required
        "usage": "single",
        "name": "common12",
        "passphrase": "foryoureyesonly1",
        "role": "teacher",
    }
]

Device

Devices are things we manufacture. They are traceable to a manufactured entry. They will be added into inventory and they will need to be assigned to a site in order to be functional.

Get Site Devices

Get list of devices on the site.

GET /api/v1/sites/:site_id/devices?name=ap-001

Request

[
    {
        "model": "AP41",
        "hw_rev": "0",
        "map_id": "01b04bbe-9687-11e8-a5a9-346895ed1b7d",
        "orientation": 0,
        "org_id": "476057fe-cebb-4be9-9c15-caf1f09d95e0",
        "site_id": "eaa6b2b7-88cd-41ea-8150-9b46b6779235",
        "mac": "5c5b350e0001",
        "modified_time": 1533206823,
        "created_time": 1533196761,
        "tag_id": 107,
        "tag_uuid": "9c557d6a-8a5e-11e6-b1db-0242ac110004",
        "serial": "1002710010001",
        "type": "ap",
        "id": "00000000-0000-0000-1000-5c5b350e0001",
        "name": "ap-001"
    }
]

Device Config

PUT /api/v1/sites/:site_id/devices/:device_id

Request Example

{
    "name": "conference room",
    "notes": "slightly off center",
    "map_id": "63eda950-c6da-11e4-a628-60f81dd250cc",
    "x": 53.5,
    "y": 173.1,
    "orientation": 45,
    "height": 3,
    "locked": false,
    "radio_config": {
        "band_24": {
            "disabled": false,

            "channel": 0,
            "bandwidth": 20,
            "power": 1,
            "antenna_mode": "1x1",
            "allow_rrm_disable": false,
        },
        "band_5": {
            "disabled": false,
            "channel": 0,
            "bandwidth": 40,
            "power": 0,
            "antenna_mode": "default"
        },
        "band_6": {
            "disabled": false,
            "channel": 0,
            "bandwidth": 40,
            "power": 0,
            "antenna_mode": "default"
        },
        "ant_gain_24": 4,       // for models with external antenna
        "ant_gain_5": 5,        // for models with external antenna
        "ant_gain_6": 5,        // for models with external antenna

        // for some AP models (e.g. AP43), 2.4G radio can operation in 5G band
        "band_24_usage": "5",  // 24 (default) / auto
        // if band_24_usage == "5", by default, band_5 properties is used, if specific channel/bandwidth/power/...
        // is desired, use the following
        "band_5_on_24_radio": {
            "disabled": false,
            "channel": 0,
            "bandwidth": 40,
            "power": 0,
            "antenna_mode": "default"
        },

        // to make an outdoor operate indoor, default is false
        // for an outdoor-ap, some channels are disallowed by default, this allows the user
        // to use it as an indoor-ap
        "indoor_use": false,

        // to switch antenna mode, for models with switchable antennas
        "ant_mode": "external",  // external / internal

        "scanning_enabled": true
    },
    "ip_config": {
        "type": "static",
        "ip": "10.2.1.1",
        "netmask": "255.255.255.0",
        "gateway": "10.2.1.254",

        "type6": "static",
        "ip6": "2607:f8b0:4005:808::2004",
        "netmask6": "/32",
        "gateway6": "2607:f8b0:4005:808::1",

        "dns": [ "8.8.8.8", "4.4.4.4" ],
        "dns_suffix": [ ".mist.local", ".mist.com" ],
        "vlan_id": 1,
        "mtu": 0
    },
    "ble_config": {
        "power_mode": "custom",
        "power": 10,
        "beacon_enabled": true,
        "beacon_rate_mode": "custom",
        "beacon_rate": 3,
        "beam_disabled": [ 1, 3, 6 ],

        // ibeacon
        "ibeacon_enabled": true,
        "ibeacon_uuid": "f3f17139-704a-f03a-2786-0400279e37c3",
        "ibeacon_major": 13,
        "ibeacon_minor": 138,
        "ibeacon_adv_power": -65,
        "ibeacon_beams": "2-4,7",  // or 'default' to auto-set

        "eddystone_uid_enabled": false,
        "eddystone_uid_namespace": "2818e3868dec25629ede",
        "eddystone_uid_instance": "5c5b35000001",
        "eddystone_uid_freq_msec": 200,
        "eddystone_uid_adv_power": -65,
        "eddystone_uid_beams": "2-4,7",  // or 'default' to auto-set

        "eddystone_url_enabled": false,
        "eddystone_url_url": "https://www.abc.com",
        "eddystone_url_freq_msec": 1000,
        "eddystone_url_adv_power": -65,
        "eddystone_url_beams": "2-4,7",  // or 'default' to auto-set

        // custom packet
        "custom_ble_packet_enabled": true,
        "custom_ble_packet_freq_msec": 300,
        "custom_ble_packet_frame": "0x........"
    },
    "usb_config": {
        "enabled": true,

        // imagotag
        "type": "imagotag",
        "host": "1.1.1.1",
        "channel": 3,
        "port": 0,
        "verify_cert": false,
        "cacert": ""

        // Solum or Hanshow
        "type": "solum", // or "hanshow"
        "vlan_id": 1, // default is 1
    },
    "esl_config": {
        "enabled": true,

        // usb_config is ignored if esl_config enabled
        "type": "imagotag",  // imagotag / hanshow / solum / native

        // imagotag, native: AP imagotage native solution
        // note: ble_config will be ingored if esl_config is enabled and with native mode. 
        "type": "imagotag", // or "native"
        "host": "1.1.1.1",
        "channel": 3,
        "port": 0,
        "verify_cert": false,
        "cacert": ""

        // Solum or Hanshow
        "type": "solum", // or "hanshow"
        "vlan_id": 1, // default is 1
    }
    "aeroscout": {
        "enabled": true,
        "host": "aero.pvt.net",
        "locate_connected": true
    },
    "centrak": {
        "enabled": true,
    },
    "airista: {
        "enabled": true,
        "host": "10.10.10.41",
        "port": 1144
    }
    "led": {
        "enabled": true,
        "brightness": 255
    },
    "mesh": {
        "enabled": true,
        "role": "base",  // base / relay
        "group": 0,
        "bands": ["5", "6"]  // default is ["5"], for relay, the first viable one will be picked
    },

    "client_bridge": {
        // when acted as client bridge
        // - only 5G radio can be used
        // - will not serve as AP on any radios        
        "enabled": true,
        "ssid": "Uplink-SSID",
        "auth": {
            "type": "psk",  // psk (default) / open            
            "psk": "foryoureyesonly",
            // - wpa2-ccmp is assumed when `psk` is choosed
        }
    },

    "uplink_port_config": {
        // whether to do 802.1x against uplink switch
        // when enaled, AP cert will be used to do EAP-TLS
        // and the Org's CA Cert has to be provisioned at the switch
        "dot1x": false,
        "keep_wlans_up_if_down": false  // by default, WLANs are disabled when uplink is down. In some scenario, like SiteSurvey, one would want the AP to keep sending beacons.
    },

    "port_config": {
        // eth0 is not allowed here
        // if spcified, this takes predecence over switch_config (switch_config requires user to configure all vlans manually, which is error-prone. thus deprecated)
        "eth1,eth2": {
            "forwarding": "all",  // all (vlans as eth0) / limited / wxtunnel / mxtunnel / site_mxedge 

            // if forwrding == limited
            "vlan_ids": [1, 10, 50],
            "port_vlan_id": 1,

            // if forwarding == wxtunnel, the port is bridged to the vlan of the session
            "wxtunnel_id": "7dae216d-7c98-a51b-e068-dd7d477b7216",
            "wxtunnel_remote_id": "wifiguest",

            // if forwarding == mxtunnel, vlan_ids comes from mxtunnel
            "mxtunnel_id": "08cd7499-5841-51c8-e663-fb16b6f3b45e",
            // optional to specify the vlan id for a tunnel if forwarding is for wxtunnel, mxtunnel and site_mxedge.
            // if vlan_id is not specified then it will use first one in vlan_ids[] of the mxtunnel
            "vlan_id": 9,

            // if forwarding == site_mxedge, vlan_ids comes from site_mxedge (`mxtunnels` under site setting)
            "mxtunnel_name": "default",
            "vlan_id": 9, // optional

            // other common attributes

            // whether to do port auth
            "port_auth": "dot1x",  // none (default)
            "enable_mac_auth": true,
            "mac_auth_protocol": "eap-md5",
            "mac_auth_preferred": false,  // when enable_mac_auth=true, we'll do dot1x then mac_auth. enable this to prefer mac_auth

            // whether simply disabled
            "disabled": false,

            // site setting will be used unless overwriten here
            "radius_config": {
                // if per-device overwrite is desired. see site setting for schema
            },
            // or radsec can be used
            "radsec": {
                // see WLAN radsec config for schema
            },
            "mist_nac": {
                "enabled": true,
            },

            // optional dynamic vlan
            "dynamic_vlan": {
                "enabled": true,
                "type": "standard",
                "vlans": {
                    "1-10": null,
                    "user": null,
                },
                "default_vlan_id": 999
            }
        }
    },

    "iot_config": {
        "DO": {
            "enabled": true,
            "value": 1
        },
        // 'DI1', 'DI2' pins can only be configured as inputs with an external pull-up
        "DI1": {
            "name": "motion",
            "enabled": true,
        },
        "A1": {
            "name": "pulled-up analog",
            "enabled": true
        }
    },
    "lacp_config": {
        "enabled": true,
    },
    "disable_eth1": false,
    // disable_eth2 and disable_eth3 are applied for some specific models, e.g. AP12
    "disable_eth2": false,
    "disable_eth3": false,
    "disable_module": false,
    "poe_passthrough": false,

    // for some AP models, flow_control can be enabled to address some switch compatibility issue
    "flow_control": {
        "enabled": true,  // default is false
    }

    "pwr_config": {
        "base": 2000,
        "prefer_usb_over_wifi": false
    },

    "vars": {
        "RADIUS_SECRET": "11s64632d",
        "RADIUS_IP1": "172.31.2.5"
    },

    "ntp_servers": [], // optional

    "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9", 

    "image1_url": "https://url/to/image.png"
}

Parameters

Radio Configs

IP Config

BLE

USB Config for Imagotag

Note: if native imagotag is enabled, BLE will be disabled automatically Note: legacy, new config moved to ESL Config.

USB Config for Solum or Hanshow

ESL Config for Imagotag or Native

Note: if native imagotag is enabled, BLE will be disabled automatically

ESL Config for Solum or Hanshow

Aeroscout Config

Centrak Config

Airista Config

LED Config

Mesh

Port Configs

Power Configs

IoT Configs

Configuration of IoT pins. By default, all the pins are disabled

Switch Config

{
    "name": "corp-a135",
    "role": "access",  // switch role
    "notes": "slightly off center",

    "ip_config": {
        // the default l3 interface of the switch
        "type": "static",
        "ip": "10.2.1.10",
        "netmask": "255.255.255.0",
        "gateway": "10.2.1.254",

        "dns": [ "8.8.8.8", "4.4.4.4" ],
        "dns_suffix": [ ".mist.local", ".mist.com" ],

        // or the network where this mgmt IP reside, this will be used as default network for
        // outbound-ssh, dns, ntp, dns, tacplus, radius, syslog, snmp
        "network": "default"
    },
    "oob_ip_config": {
        // out-of-band (vme/em0/fxp0) IP config
        // same payload as `ip_config` except dns / dns_suffix / gateway

        // for HA Cluster, node1 can have different IP Config
        "node1": {
            // same payload as `ip_config` except dns / dns_suffix / gateway
        }

        // if supported on the platform. If enabled, DNS will be using this routing-instance, too
        "use_mgmt_vrf": false  // false (default) / true

        // for host-out traffic (NTP/TACPLUS/RADIUS/SYSLOG/SNMP), if alternative source network/ip is desired, 
        "use_mgmt_vrf_for_host_out": false, // false (default), whether to use `mgmt_junos`
    },

    // most of the time, it's better to use `port_usages` and `networks` in Site Setting to achieve better consistency
    // and be able to re-use the same settings across switches
    // entries defined here will "replace" those defined in Site Setting/Network Template
    "networks": {
        "guest": {
            "vlan_id": 300,
            "ospf_passive": true
        }
    },

    "other_ip_configs": {
        // optional, if it's required to have switch's L3 presense on a network/vlan 
        "guest": {
            "type": "static",
            "ip": "10.3.3.1",
            "netmask": "255.255.255.0",  // optional, `subnet` from `network` definition will be used if defined

            // for EVPN, if anycast is desired
            "evpn_anycast": false   // default is false 

            "type6": "static",  // disabled (default) / autoconf / dhcp / static
            "ip6": "fdad:b0bc:f29e::3d16",
            "netmask6": "/64",
            "gateway6": "fdad:b0bc:f29e::1"
        }
    },
    "ntp_servers": [
        "pool.ntp.org",
        "time.google.com"
    ],
    // global dns settings. To keep compatibility, dns settings in ip_config and oob_ip_config
    // will overwrite this setting
    "dns_servers": [ "8.8.8.8", "4.4.4.4" ],
    "dns_suffix": [ ".mist.local", ".mist.com" ],

    "port_config": {
        "ge-0/0/0": {
            "usage": "uplink"

            // if aggregated
            "aggregated": true,
            "ae_idx": 1,                      // optional. Users could force to use the designated AE name
            "ae_disable_lacp": true,          // optional. To disable LCP support for the AE interface
            "description": "to dist-sw-01",   // optional
            "ae_lacp_slow": true,             // optional, by default, fast timeout is used
            // for esilag
            "esilag": true
        },
        "ge-0/0/1": {
            "usage": "default",
            // Enable dynamic usage for this port
            "dynamic_usage": "dynamic"
        },
        "ge-0/0/8-16,ge-1/0/0-47": {
            "usage": "ap"
        },

        "ge-0/0/2-3": {
            "usage": "evpn_uplink'
        },

        "ge-0/0/4": {
            "usage": "inet",
            "port_network": "guest",

            // optional
            // speed, duplex, disable_autoneg, mtu, poe_disabled            
        },

        "ge-0/0/5": {
            "usage": "vlan_tunnel",
            "port_network": "customer1",  // required

            // optional
            // speed, duplex, disable_autoneg, mtu, disabled, poe_disabled, storm_control          
        },

        // this is assumed
        "*": {
            "usage": "default"
        }
    },

    // per-device only, supported attributes:
    // - description
    // - poe_disabled
    // - disabled
    // - speed
    // - duplex
    // - mac_limit
    // - port_network
    "port_config_overwrite": {
        "ge-0/0/9": {
            "disabled": true
        },
    },

    // static routes
    "extra_routes": {
        "it_mgmt": {   // use names from `networks`
            "via": "10.2.1.1",

            // all optional
            "metric": null,  // 0-4294967295
            "preference": 30,  // 0-4294967295
            "next_qualified": {
                "10.3.1.1": {
                    "metric": null,
                    "preference": 40
                },                
            },
            "discard": false,  // this takes precedence
            "no_resolve": false
        },
        "172.16.3.0/24": {
            "via": "10.2.1.1"
        }
    },
    // for ipv6
    "extra_routes6": {
        "2a02:1234:420a:10c9::/64": {
            "via": "2a02:1234:200a::100"
        }
    },

    // aggregate routes
    "aggregate_routes": {
        "172.16.3.0/24": {
            // all optional
            "metric": null,  // 0-4294967295
            "preference": 30,  // 0-4294967295
            "discard": false
        }
    },
    // for ipv6
    "aggregate_routes6": {
        "2a02:1234:420a:10c9::/64": {}
    },

    // used for ospf / bgp / ...
    "router_id": "10.2.1.10",
    // whether to use it for snmp / syslog / tacplus / radius
    "use_router_id_as_source_ip": false,

    "stp_config": {
        "bridge_priority": "40k", // 32k (default), Range [0, 4k, 8k.. 60k] in steps of 4k. Bridge priority applies to both VSTP and RSTP.
    }

    // to enable OSPF on this device
    "ospf_config": {
        "enabled": true,
        "reference_bandwidth": "100M", //Bandwidth for calculating metric defaults (9600..4000000000000), default is 100M
        "areas": {
            "0": {
                "no_summary": false
            }
        },
        // optional, for basic scenario, below can be specified and can be applied 
        // to all networks in all areas if not explicitly specified
        "export_policy": "hello",
        "import_policy": "test"
    },

    "dhcpd_config": {
        "enabled": true,
        "corp": {
            "type": "local",  // default
            "ip_start": "192.168.70.100",
            "ip_end": "192.168.70.200",                
            "gateway": "192.168.70.1",

            // Maximum number of seconds the lease can be held
            "lease_time": 86400, // in seconds, lease time has to be between 3600 [1hr] - 604800 [1 week], default is 86400 [1 day]

            // optional, system one will be used
            "dns_servers": [ "8.8.8.8", "4.4.4.4" ],
            "dns_suffix": [ ".mist.local", ".mist.com" ],

            // fixed binding
            "fixed_bindings": {
                "5684dae9ac8b": {
                    "name": "John",
                    "ip": "192.168.70.35",
                    "ip6": "2607:f8b0:4005:808::2"
                }
            }

            // if using DHCP relay
            "type": "relay",
            "servers": ["11.2.3.4"],

            // if using DHCPv6 server
            "type6": "local" // none (default) / relay / local
            "ip6_start": "2607:f8b0:4005:808::2",
            "ip6_end": "2607:f8b0:4005:808::ff",

            // if using DHCPv6 relay
            "type6": "relay"
            "serversv6": ["2607:f8b0:4005:808::64"]

            // when defined in template, this allows device to override
            "disabled": false
        },
        // it's common for many networks to use the same dhcp relay, comma-separated network names can be used here
        "net1,net2": {
            "type": "relay",
            "servers": ["11.2.3.4"]
        }        
    },

    "dhcp_snooping": {
        "enabled": true,
        "all_networks": false,

        // if all_networks = false
        "networks": [ "corp" ],

        // Enable for dynamic ARP inspection check 
        "enable_arp_spoof_check": true,

        // Enable for check for forging source IP address
        "enable_ip_source_guard": true,
    },

    // to enable VRRP on this device
    "vrrp_config": {
        "enabled": true,
        "groups": {
            "0": {
                // optional
                "priority": 200,
                "preempt": true, // default false, allow preemption (a backup router can preempt a primary router)
            }
        }
    },

    "vrf_config": {
        "enabled": true,  // whether to enable VRF (when supported on the device)
    },

    "acl_tags": {

        "iot": {
            "type": "mac",
            "network": "iot",  // optional, default is any
            "macs": ["010203040506", "abcdef*"],
        },

        "printer": {
            "type": "subnet",
            "network": "lan",  // optional, default is any
            "subnets": ["192.168.1.30/32"]
        },

        "guest": {
            "type": "network",
            "network": "guest"
        },

        "vip_from_filter_id": {
            "type": "radius_group",
            "radius_group": "VIP"
            // optional
            "subnets": ["192.168.1.30/32"],
            "specs": [
                {
                    "protocol": "tcp",  // tcp / udp / icmp / gre / any / ":protocol_number", `protocol_number` is between 1-254, default is `any`
                    "port_range": "80"  // matched dst port, "0" means any, default is "0"
                }                
            ]
        },

        "iot": {
            "type": "port_usage",
            "port_usgae": "iot",
            // optional
            "subnets": ["192.168.1.30/32"],
            "specs": [
                {
                    "protocol": "tcp",  // tcp / udp / icmp / gre / any / ":protocol_number", `protocol_number` is between 1-254, default is `any`
                    "port_range": "80"  // matched dst port, "0" means any, default is "0"
                }                
            ]
        },

        // implicit, cannot override
        "any": {
            // matching anything not identified
            "type": "any"
        },

        "resource": {
            // resource can only be used in `dst_tags`
            "type": "resource",

            "network": "dmz",  // default is any
            "subnets": ["192.168.0.5"],  // default is any
            "ether_types": ["arp"] // arp / ipv6. Default is any. Can only be used under dst tags. 
            "specs": [
                {
                    "protocol": "tcp",  // tcp / udp / icmp / gre / any / ":protocol_number", `protocol_number` is between 1-254, default is `any`
                    "port_range": "80"  // matched dst port, "0" means any, default is "0"
                }                
            ]  // empty means unrestricted, i.e. any
        },

        // GBP tags
        "vip_tagged_by_radius": {
            // from the gbp_tag received from RADIUS
            "type": "dynamic_gbp",
            "gbp_tag": 100,
        },

        "vip_tagged_from_traffic": {
            // applying gbp tag against matching conditions
            "type": "static_gbp",
            "gbp_tag": 100,

            // or matching network (vlan)           
            "network": "employee",
            // or subnet
            "subnets": ["192.168.0.0/16"],
            // or MAC
            "macs": ["010203040506", "abcdef*"]
        },

        "gbp_resource": {
            // can only be used in `dst_tags`
            "type": "gbp_resource",
            "gbp_tag": 100,
            "specs": [
                {
                    "protocol": "tcp",  // tcp / udp / gre / icmp / icmp6
                    "port_range": "80"  // matched dst port, "0" means any
                }                
            ]
        },
    },

    "acl_policies": [
        {
            "name": "guest access",
            "src_tags": ["macs"], 
            "actions": [
                {
                    "dst_tag": "rfc1918", 
                    "action": "deny"
                }, 
                {
                    "dst_tag": "corp", 
                    "action": "allow"
                }
            ]
        },
        {
            "name": "corp"
            "src_tags": ["corp-vip"], 
            "actions": [
                {
                    "dst_tag": "corp", 
                    "action": "allow"
                }, 
                {
                    "dst_tag": "corp-port-ranged", 
                    "action": "deny"
                }
            ]
        }

        // NOTES:
        // 1. for GBP-based policy, all src_tags and dst_tags have to be gbp-based
        // 2. for ACL-based policy, `network` is required in either the source or destination
        //    so that we know where to attach the policy to
    ],

    // EVPN
    see EVPN section

    // optional, most of the times, `radius_config` comes from Site Settings; however, there are occasions where 
    // we may want to try experimental radius servers
    "radius_config": {
        "auth_servers_timeout": 5,
        "auth_servers_retries": 3,
        "auth_servers": [
            {
                "host": "1.2.3.4",
                "port": 1812,
                "secret": "testing123"
            },
            {
                "host": "radius.internal",
                "port": 1812,
                "secret": "testing123"
            }
        ],
        "acct_servers": [
            {
                "host": "1.2.3.4",
                "port": 1812,
                "secret": "testing123"
            }
        ],
        "acct_interim_interval": 0,

        // Enable COA. Default is false. When coa_port is not specified, 3799 is the default value.
        “coa_enabled”: true,
        “coa_port”: 3799,

        // which network the RADIUS server resides, if there's static IP for this network,
        // we'd use it as source-ip
        "network": "default"

        // or specifiy "source_ip" directly
        "source_ip": "192.168.3.5"
    },

    // for an adopted switch, this can be enabled to make it fully-managed by mist
    "managed": false,

    // for a claimed switch, this can disable auto configuration
    "disable_auto_config": false,

    // additional CLI commands to append to the generated config
    // NOTE: no check is done
    "additional_config_cmds": [
        "set snmp community public"
    ],

    "vars": {
        "RADIUS_SECRET": "11s64632d",
        "RADIUS_IP1": "172.31.2.5"
    },
    "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9",
    "image1_url": "https://url/to/image.png",

    // port_mirroring
    "port_mirroring": {
        "port_mirror": {
            // at least one of them should be specified
            "ingress_port_ids": [ "ge-0/0/3" ],
            "egress_port_ids": [ "ge-0/0/3" ],
            "ingress_networks": [ "corp" ],

            // exactly one of the output should be provided
            "output_port_id": "ge-0/0/5",
            "output_ip_address": "1.2.3.4"
            "output_network": "analyze",

            // future
            "filter": { ... }
        }
    },

    // IOT ports
    "iot_config": {
        // IN0 and IN1 triggered by input over 5v
        "IN0": {
            "name": "dry contact",
            "enabled": true,
            "alarm_class": "major",  // minor (default) / major
        },
        "IN0": {
            "name": "motion",
            "enabled": true,
            "alarm_class": "major",  // minor (default) / major
        },

        // OUT can only be triggered by either IN0 or IN1
        "OUT": {
            "name": "output",
            "enabled": true,
            "input_src": "IN0",  // IN0 (default) / IN1
            "alarm_class": "minor",  // minor (default) / major
        }

        // for VC
        "1/IN0": {
            "name": "dry contact",
            "enabled": true,
            "alarm_class": "major",  // minor (default) / major
        },
        "1/OUT": {
            "name": "output",
            "enabled": true,
            "input_src": "IN0",  // IN0 (default) / IN1
            "alarm_class": "minor",  // minor (default) / major
        }
    },

}

Switch-specific Parameters

Switch IP Config

Switch DNS Config

Switch and Gateway OSPF

Extra Routes

Get ZTP Password

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.

POST /api/v1/sites/:site_id/devices/:device_id/request_ztp_password

Response Example

{
    "root_password": "ef8070ef8f924edb592e1819ed64b31172ab8de9d5cde75d3f46acd9506202ab9b1cbb97e381c5aa11037f17e5ed7b4b609461cd813d944670549d410ef82f2e"
}

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

GET /api/v1/sites/:site_id/devices/:device_id/config_cmd

Optional parameter

Response

{
    "cli": [
        "set system hostname corp-a135"
        ...
    ]
}

EVPN

EVPN allows an alternative but more efficient LAN architecture utilizing VxLAN / MP-BGP - separating control plane (MAC / IP Learning) from forwarding plane.

In our implementation, following the steps to deploy EVPN topologies in a Site

1. build the topology

While all the evpn_id / downlink_ips can be specified 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

POST /api/v1/sites/:site_id/evpn_topologies

Request

{
    "overwrite": true
    "name": "CC",
    "pod_names": {
        "1": "default",
        "2": "default"
    },
    // evpn topology options
    "evpn_options": {
        "overlay": {
            // optional, these are defaults
            "as": 65000
        },
        "underlay": {
            "as_base": 65001,
            "router_id_prefix": "/24",
            "subnet": "10.255.240.0/20",  // underlay subnet, by default, 10.255.240.0/20, or 'fd31:5700::/64' for ipv6

            // if v6 is desired for underlay
            "use_ipv6": true
        },
        // optional, where virtual-gateway should reside
        "routed_at": "edge",  // edge (default) / core / distribution

        // optional, for ERB or CLOS, you can either use esilag to upstream routers or to also be the virtual-gateway        
        "core_as_border": false,  // when routed != "core", whether to do virtual-gateway at core as well, default is false

        // inband-ztp
        // if the mangement traffic goes inbnd, during installation, only the border/core switches are connected to the Internet
        // to allow initial configuration to be pushed down and leave the downstream access switches stay in the Factory Default state
        // enabling inband-ztp allows upstream switches to use LLDP to assign IP and gives Internet to downstream switches in that state 
        "enable_inband_ztp": true,  // default is false

        // by default, JUNOS uses 00-00-5e-00-01-01 as the virtual-gateway-address's v4-mac and 00-00-5e-00-02-01 for v6-mac
        "per_vlan_vga_v4_mac": false,  // if enabled, 00-00-5e-00-0X-YY will be used (where X=vlan_id/256, YY=vlan_id%256),
        "per_vlan_vga_v6_mac": false,  // if enabled, 00-00-5e-00-1X-YY will be used (where X=vlan_id/256, YY=vlan_id%256),

        // optional, this generates router_id automatically, if specified, `router_id_prefix` is ignored
        "auto_router_id_subnet": "100.100.0.0/24",   // optional
        "auto_router_id_subnet6": "fd31:5700:1::/64",  // subnet for lo0.0 v6 IP, default is 'fd31:5700:1::/64'

        // optional, for dhcp_relay, unique loopback IPs are required for ERB or IPClos where we can set option-82 server-id-overrides
        "auto_loopback_subnet": "100.101.0.0/24",
        "auto_loopback_subnet6": "fd33:ab00:2::/64",

        // optional, for EX9200 only to seggregate virtual-switches
        "vs_instances": {
            "guest": {
                "networks": ["guest"]
            },
            "iot": {
                "networks": ["iot-wifi", "iot-lan"]
            }    
        }
    },
    "switches": [
        {
            "mac": "5c5b35000003",
            "role": "collapsed-core",

            // by default, core switches are assumed to be connecting all pods
            // if you want to limit the pods, you can specify pods
            "pods": [ 1, 2 ]
        },
        {
            "mac": "5c5b35000004",
            "role": "collapsed-core",
        },
        {
            "mac": "5c5b3500000f",
            "role": "esilag-access",

            // optionally, for distribution / access / esilag-access, they can be placed into different pods
            // e.g. for CLOS, to group dist / access switches into pods
            //      for ERB/CRB, to group dist / esilag-access into pods
            "pod": 1  // 1-255 (default is 1)
        }        
    ],
    // common configs for all switches in the topology
    "config": {
        // see switch related in [Site Setting]
    },
    // switch-specific configs
    "switch_configs": {
        "5c5b35000003": {
            // see switch related in [Site Setting]
        },
        ...
    }
}

Response

{
    "id": "9197ec96-4c8d-529f-c595-035895e688b2",
    "name": "CC",
    "pod_names": {
        "1": "default",
        "2": "default"
    },

    "switches": [
        {
            "mac": "5c5b35000003",
            "model": "QFX10002-36Q",
            "role": "collapsed-core",

            // below are generated
            "evpn_id": 1,
            // the links, if not specified in the request, suggested ones will be used
            "uplinks": ["5c5b35000005", "5c5b35000006"],
            "downlinks": ["5c5b35000007", "5c5b35000008"],
            "esilaglinks": ["5c5b3500000f"],
            "site_id": "1916d52a-4a90-11e5-8b45-1258369c38a9",
            "deviceprofile_id": "6a1deab1-96df-4fa2-8455-d5253f943d06",

            // all the required links for this topology
            "suggested_uplinks": ["5c5b35000005", "5c5b35000006"],
            "suggested_downlinks": ["5c5b35000007", "5c5b35000008"],
            "suggested_esilaglinks": ["5c5b3500000f"]
        },
        ...
        {
            "mac": "5c5b3500000f",
            "model": "EX4300-48P",
            "role": "esilag-access",
            "esilaglinks": ["5c5b35000003", "5c5b35000004"]
        }        
    ]    
}

2. update the topology

PUT /api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id

{
    "overwrite": false,

    "switches": [
        // to add a new node to the topology, add it with the desired role
        {
            "mac": "5c5b35000003",
            "role": "collapsed-core"
        },

        // to remove a node from the topology, set the role to 'none'
        {
            "mac": "5c5b35000004",
            "role": "none"
        }        
    ]
    // to add switches to topology

}

3. specify ports for each switch that will be used for uplink/downlinks

Specify the actual physical ports you have used (or plan to use) to inter-connect the switches.

PUT /api/v1/sites/:site_id/devices/:device_id

{
    "port_config": {
        "ge-0/0/10-11": {"usage": "evpn_uplink"},
        "ge-0/0/20-21": {"usage": "evpn_downlink"},
        "ge-0/0/30-31": {"usage": "esilag"},
    }
}

Note: only use one entry for the same evpn_uplink/evpn_downlink as the order is improtant. For example, the above config will configure 5c5b35000003’s ge-0/0/10 to connect to 5c5b35000005.

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

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

In the following example, two distribution switches

// on two aggragation switches where both ge-0/0/10's are intended to connect to access#1 and
// ge-0/0/11's to access#2
{     
    "port_config": {
        "ge-0/0/10": {
            "usage": "esilag",
            "ae_idx": 1
        },
        "ge-0/0/11": {
            "usage": "esilag",
            "ae_idx": 2
        },
     }
}

// on two access switches that simply treat do normal port aggregation
{
    "port_config": {
        "ge-0/0/1-2": {
            "usage": "esilag",
            "aggregate": true
        },
     }
}

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

{
    "other_ip_configs": {
        "guest": {
            "ip": "192.168.70.1"
        },
        "iot-wifi": {
            "ip": "192.168.80.1"
        },
        "iot-lan": {
            "ip": "192.168.81.1"
        },
    },

    // optionally VRF (this can be defined in site settings / network templates)
    "vrf_instances": {
        "guest": {
            "networks": ["guest"]
        },
        "iot": {
            "networks": ["iot-wifi", "iot-lan"]
        }    
    },
    # for the device
    "vrf_config": {
        "enabled": true
    }    
}

7. Other APIs

Get All EVPN Topologies

Get the existing EVPN topology

GET /api/v1/sites/:site_id/evpn_topologies

Get One EVPN Topology Detail

Get the existing EVPN topology

GET /api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id

Delete EVPN Topology

Delete existing EVPN topology

DELETE /api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id

Rebuild EVPN Topology

Rebuild existing EVPN topology

PUT /api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id

Gateway Config (draft)

Gateway comes with a default configuration with WAN + LAN where * WAN port gets IP from DHCP * LAN port(s) has an IP of 192.168.1.1/24 with DHCP Server

This is determined by the missing of port_config for a Gateway where the following are assumed, matching Gateway’s factory-default config

    "port_config": {
        "ge-0/0/0": {  // model-dependent
            "usage": "wan"
        },
        "ge-0/0/1-5": {  // model-dependent
            "usage": "lan",
            "port_network": "default"
        }
    }        

Minimum

To start adding configs, say to use static IP on WAN and change the subnet on LAN side to use 192.168.30.0/24

    "port_config": {
        "ge-0/0/0": {
            "usage": "wan",
            "ip_config": {
                "ip': "63.31.5.7",
                "netmask": "/32",
                "gateway": "63.31.5.254"                
            }
        },
        "ge-0/0/1-5": {
            "usage": "lan",
            "port_network": "default"
        }
    },
    "ip_configs": {
        "default": {
            "type": "static",
            "ip": "192.168.30.1",
            "netmask": "/24"
        }
    },

    // dhcpd_config is assumed to be enabled for `default` network and 

Port-Mirroring

Sample port-mirror config for SRX devices

"port_mirroring": {
    "port_mirror": {
        "run_length": 12,
        "rate": 2,
        "family_type": 'inet',
        "ingress_port_ids": ["ge-0/0/3", "ge-0/0/4"],
        "output_port_id": "ge-0/0/5",
    }
}

Networks

see Networks

networks can be configured directly in Gateway Config directly for smaller deployemnt (e.g. Home, Testing)

Services

see Services

services can also be configured directly in Gateway Config directly for smaller deployemnt (e.g. Home, Testing)

Spec

{
    "name": "corp-a135",

    // gateways use/share `networks` that switches uses 
    "networks": {
        // see Gateway Template
    },

    "port_config": {
        // see Gateway Template
    },

    "ip_configs": {
        "corp": {
            "type": "static",
            "ip": "192.168.10.1"
        }
    },

    "dhcpd_config": {
        "enabled": true,
        "corp": {
            "type": "local",  // local (default) / relay / none
            "ip_start": "192.168.70.100",
            "ip_end": "192.168.70.200",                
            "gateway": "192.168.70.1",

            // optional, system one will be used
            "dns_servers": [ "8.8.8.8", "4.4.4.4" ],
            "dns_suffix": [ ".mist.local", ".mist.com" ],

            // fixed binding
            "fixed_bindings": {
                "5684dae9ac8b": {
                    "name": "John",
                    "ip": "192.168.70.35"
                }
            },

            // server_options
            "options": {
                "80": {
                    "type": "string",  //  string / boolean / ip / hex / int16 / int32 / uint16 / uint32

                    "value": "string",  // string
                    "value": "686578",  // hex
                    "value": "true",    // single boolean
                    "value": "1.1.1.1,2.2.2.2"  // list of ip addresses, comma-separated
                }                
            },
            "vendor_encapsulated": {
                // <enterprise number>:<sub option code> 
                // enterprise number": 25300,  // 1-65535  (https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers)
                // sub option code": 8,  // 1-255, sub-option code
                "25300:8": {
                    "type": "string",  //  string / boolean / ip / hex / int16 / int32 / uint16 / uint32
                    "value": ...  // see above
                }
            },

            //
            // if using DHCP relay
            //
            "type": "relay",
            "servers": ["11.2.3.4"],

            // server_id_override
            //   Default is false.
            //   True means the device, when acts as DHCP relay and forwards DHCP responses from DHCP server to clients, 
            //   should overwrite the Sever Identifier option (i.e. DHCP option 54) in DHCP responses with its own IP address.
            "server_id_override": true
        }
    },

    "extra_routes": {
        "0.0.0.0/0": {
            "via": "10.2.1.1"
        }   
    },

    "oob_ip_config": {
        // fxp0 IP config

        "type": "static",
        "ip": "192.168.50.3",
        "netmask": "255.255.255.0",

        // when there are 2 routing engines, re1 mgmt IP has to be set separately (if desired)
        "re1": {
            // same payload as `ip_config` except dns / dns_suffix / gateway
        },

        // if supported on the platform, whether to place OOB port into it's own RI (mgmt_junos)
        // https://www.juniper.net/documentation/us/en/software/junos/junos-getting-started/topics/topic-map/management-interface-in-non-default-instance.html
        "use_mgmt_vrf": false  // false (default) / true
    },

    "ntp_servers": [
        "pool.ntp.org",
        "time.google.com"
    ],

    // for an adopted gateway/switches, this can be enabled to make it fully-managed by mist
    "managed": false,

    // additional CLI commands to append to the generated config
    // NOTE: no check is done
    "additional_config_cmds": [
        "set snmp community public"
    ],

    "vars": {
        "RADIUS_SECRET": "11s64632d",
        "RADIUS_IP1": "172.31.2.5"
    },
    "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9",
    "image1_url": "https://url/to/image.png"
}

Attach Device Image

Attach up to 3 images to a device

POST /api/v1/sites/:site_id/devices/:device_id/image1
POST /api/v1/sites/:site_id/devices/:device_id/image2
POST /api/v1/sites/:site_id/devices/:device_id/image3

Request

A multi-part POST

"file": a binary file

Remove Device Image

Delete background image for Portal

DELETE /api/v1/sites/:site_id/devices/:device_id/image1
DELETE /api/v1/sites/:site_id/devices/:device_id/image2
DELETE /api/v1/sites/:site_id/devices/:device_id/image3

Device Locating - AP

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

POST /api/v1/sites/:site_id/devices/:device_id/locate

Device Locating - Switch

Locate a Switch by blinking all port LEDs. By default, request is sent to ‘master’ switch and LEDs will keep flashing for 5 minutes. In case of virtual chassis (VC) the desired member mac has to be passed in the request payload. At anypoint, only one VC member can be requested to flash the LED. To stop LED flashing before the duration ends /unlocate API request can be made. If /unlocate API is not called LED will continue to flash on device for the given duration. Default duration is 5 minutes and 120 minutes is the maximum.

POST /api/v1/sites/:site_id/devices/:device_id/locate

Request

{
    "mac": "f01c2d4ff760",  // optional: for virtual chassis, the MAC of the member
    "duration": 5  // minutes (1 - 120, default is 5)
}

Params

Response

Status: 200 OK - locating requested
Status: 400 couldn't find member mac

Device Stop Locating - AP, Switch

Stop Locate a Device

POST /api/v1/sites/:site_id/devices/:device_id/unlocate

Device Restart

Restart / Reboot a device

POST /api/v1/sites/:site_id/devices/:device_id/restart

Request

{
    // optional: for SSR, if node is not present, both nodes are restarted
    // for other devices, node should not be present
    "node": "node0",
    // optional for VC member
    "member": 1
}

Response

Status: 200 OK

Restarting multiple devices

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

POST /api/v1/sites/:site_id/devices/restart

Request

{
    "device_ids": [
        "00000000-0000-0000-1000-5c5b35584a6f",
        "00000000-0000-0000-1000-5c5b350ea3b3"
    ]
    // optional: for SSR, if node is not present, both nodes are restarted
    // for other devices, node should not be present
    "node": "node0"
}

Response

Status: 200 OK

Device Snapshot

POST /api/v1/sites/:site_id/devices/:device_id/snapshot

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

Snapshot Response

Status: 200 OK
Status: 400 - snapshot not supported
Status: 400 - cannot snapshot an offline device

Device Clear Pending Fw Version

POST /api/v1/sites/:site_id/devices/:device_id/clear_pending_version

Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)

Response

Status: 200 OK
Status: 400 - clear-pending-fw-version not supported
Status: 400 - cannot clear pending version on an offline device

Clear Pending Fw Version on Multiple Devices

POST /api/v1/sites/:site_id/devices/clear_pending_version

Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)

Response

Status: 200 OK
Status: 400 - clear-pending-version not supported
Status: 400 - cannot clear pending version on an offline device

Device Restore Backup Fw Version

POST /api/v1/sites/:site_id/devices/:device_id/restore_backup_version

Restore device backup fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)

Response

Status: 200 OK
Status: 400 - restore-backup-fw-version not supported
Status: 400 - cannot restore backup version on an offline device

Restore Backup Fw Version on Multiple Devices

POST /api/v1/sites/:site_id/devices/restore_backup_version

Restore device backup fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)

Response

Status: 200 OK
Status: 400 - restore-backup-version not supported
Status: 400 - cannot restore backup version on an offline device

Upload Device support files

Support / Upload device support files

POST /api/v1/sites/:site_id/devices/:device_id/support

Request

{
    "info": "process"
    "node": "node0"
}

Params

Info Param

Response

Status: 200 OK - uploading started
Status: 400 Device not online

Device Synthetic Test

POST /api/v1/sites/:site_id/devices/:device_id/synthetic_test

Request

{
    "type": "dns",  // dns / arp / dhcp / curl / radius / speedtest / dhcp6 / lan_connectivity
    "vlan_id": 30,  // required for AP
    "tenant": "lan_network1", // for curl/ lan_connectivity

    // type = dns
    "hostname": "google.com".

    // type = arp
    "ip": "192.168.3.5",

    // type = curl
    "url": "https://www.example.com",
    "timeout": 60, // max_time, default is 60, Range 30-120

    // type = radius
    "username": "user",
    "password": "test123",

    // type = speedtest
    "port_id": "wan0", // required for ssr

    // type = lan_connectivity
    "protocol": "ping", // ping / traceroute / ping+traceroute(default)
    "host": "www.example.com",
    "ping_details": false, // false(default) / true
    "ping_count": 10, // default is 10, max 60
    "ping_size": 56, // default is 56. Range 56-65535
    "traceroute_udp_port": 33434, // SRX only, traceroute udp port (default is 33434),
}

Response

Status: 200 OK - scheduled
Status: 400 Device not online
Status: 400 Device not supported
Status: 400 already in progress

Get Device Synthetic Testing Status

GET /api/v1/sites/:site_id/devices/:device_id/synthetic_test

Response

{
    // TBD extra information populated
    "start_time": 1675718807,
    "device_type": "gateway",
    "type": "speedtest",
    "mac": "5c5b35584a6f",
    "port_id": "ge-0/0/1.100",
    "status": "inprogress"
}

Device Bios Upgrade

POST /api/v1/sites/:site_id/devices/:device_id/upgrade_bios

Upgrade device bios

Request

{
    "version": "CDEN_P_EX1_00.20.01.00"
}

Parameters

Bios Upgrade Response

{
    "timestamp": 1428949501,
    "status": "inprogress",
}

Upgrade Bios Multiple Device

POST /api/v1/sites/:site_id/devices/upgrade_bios

Request

{
    "version": "CDEN_P_EX1_00.15.01.00",
    // filters that can be used, if no filter specified, it means entire site
    "device_ids": [
        "00000000-0000-0000-1000-5c5b35584a6f"
    ],

    "models": [
        "EX4400-48T"   
    ]
}

Parameters

Device FPGA Upgrade

POST /api/v1/sites/:site_id/devices/:device_id/upgrade_fpga

Upgrade device bios

Request

{
    "version": "REV37"
}

Parameters

Bios Upgrade Response

{
    "timestamp": 1428949501,
    "status": "inprogress",
}

Upgrade Bios Multiple Device

POST /api/v1/sites/:site_id/devices/upgrade_fpga

Request

{
    "version": "REV37",
    // filters that can be used, if no filter specified, it means entire site
    "device_ids": [
        "00000000-0000-0000-1000-5c5b35584a6f"
    ],

    "models": [
        "EX2300-24MP"   
    ]
}

Parameters

Device Upgrade

POST /api/v1/sites/:site_id/devices/:device_id/upgrade

Upgrade device firmware

Request

{
    "version": "3.1.5"
}

Parameters

Upgrade Response

{
    "timestamp": 1428949501,
    "status": "inprogress",
    "status_id": 5
}

Definition

Upgrade Multiple Device

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

POST /api/v1/sites/:site_id/devices/upgrade

Request

{
    "version": "3.1.5",
    "enable_p2p": true,
    "p2p_parallelism": 2, 
    "p2p_cluster_size": 10,

    // filters that can be used, if no filter specified, it means entire site
    "device_ids": [
        "00000000-0000-0000-1000-5c5b35584a6f"
    ],
    "models": [
        "AP41"   
    ],
    "rules": [
        {
            // all AP63's in this site will be selected for upgrade
            "match_model": "AP63"
        },
        {
            // AP43's whose name has the word 'access' from character 2 to 7 will be selected for upgrade
            "match_model": "AP43",
            "match_name[2:8]": "access"
        }
    ],
    "strategy": "canary",
    "canary_phases": [5,25,50,100],
    "max_failures": [1,1,5,5], // will be used if provided, else max_failure_percentage will be used
    "max_failure_percentage": 5
    "start_time": 1624399840,
    "reboot_at": 1624399840,
    "force": True,

    // rrm
    "rrm_node_order": "fringe_to_center",
    "rrm_slow_ramp": true,
    "rrm_max_batch_percentage": 10,
    "rrm_first_batch_percentage": 2,
    "rrm_mesh_upgrade": "parallel"     
}

Parameters

Rules

Get all upgrades for site

GET /api/v1/sites/:site_id/devices/upgrade
GET /api/v1/sites/:site_id/devices/upgrade?status=completed

Response

{
    [{
            "id": "e110e3ef-5ce9-4c7c-a056-714f154f354f",
            "target_version": "apfw-0.7.20216-gilly-d4fc",
            "status": "downloading",
            "strategy": "big_bang",
            "enable_p2p": false,
            "force": true,
            "start_time": 1624499588,
            "reboot_at": 1624499588,
            "max_failure_percentage": 5,
            "counts": {
                "download_requested": 1,
                "downloaded": 2,
                "total": 3
            }
        },
        {
            "id": "57bf9d30-bd30-48e6-bb76-43c2efa375dc",
            "target_version": "apfw-0.7.20216-gilly-d4fc",
            "status": "completed",
            "strategy": "serial",
            "enable_p2p": false,
            "force": false,
            "start_time": 1624499588,
            "reboot_at": 1624499588,
            "max_failure_percentage": 5,
            "counts": {
                "upgraded": 2,              
                "failed": 1,
                "total": 3
            }
        }
    ]
}

Get site upgrade

GET /api/v1/sites/:site_id/devices/upgrade/:upgrade_id

Response

{
    "id": "b040efc5-6bb0-423e-8f7d-66d80176aa71",
    "target_version": "apfw-0.11.25907-kedge-9019",
    "status": "completed",
    "strategy": "big_bang",
    "enable_p2p": true,
    "force": true,
    "start_time": 1648752756,
    "reboot_at": 0,
    "targets": {
        "scheduled": [],
        "download_requested": [],
        "downloaded": [],
        "reboot_in_progress": [],
        "rebooted": [],
        "upgraded": [
            "5c5b354e35f7",
            "5c5b353e537a"
        ],
        "skipped": [],
        "failed": [
            "5c5b353e190a"
        ],
        "total": 3
    }
}

Cancel upgrade

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

POST /api/v1/sites/:site_id/devices/upgrade/:upgrade_id/cancel

Re-provision all devices in the Site

To force every device to reprovision itself again. By default, only APs are reprovisioned

POST /api/v1/sites/:site_id/devices/reprovision

Re-provision one device

To force one device to reprovision itself again.

POST /api/v1/sites/:site_id/devices/:device_id/reprovision

Zeroize all FIPS APs in the Site

POST /api/v1/sites/:site_id/devices/zerioze

Request

{
    "password": "NUKETHESITE"
}

Parameters

Send arbitrary BLE Beacon for a period of time

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

POST /api/v1/sites/:site_id/devices/send_ble_beacon

Request

{
    // by default, all APs in the site will be considered
    "macs": [
        "5c5b35584a6f",
        "5c5b350ea3b3"
    ],
    "map_ids": [ "845a23bf-bed9-e43c-4c86-6fa474be7ae5" ],

    "beacon_frame": "68b329da9893e34099c7d8ad5cb9c940",
    "beacon_freq": 100,
    "duration": 10,  // 1 - 60
}

Radius Synthetic Test from Switch

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

POST /api/v1/sites/:site_id/devices/:device_id/check_radius_server

Request

{
    "user": "username",
    "password": "password",
    "profile": "profilename"
}

Parameters

Response

{
    "session": "session_id"
}

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.

POST /api/v1/sites/:site_id/devices/:device_id/ping

Request

{
    "host": "1.1.1.1",
    "count": 10
}

Parameters

Response

{
    "session": "session_id"
}

Subscribe to Device Command outputs

WS /api-ws/v1/stream

Request

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

Response

{
    "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"
    }
}

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

POST /api/v1/sites/:site_id/devices/:device_id/service_ping

Request

{
    "host": "1.1.1.1",
    "count": 10,
    "service": "web-session"
}

Parameters

Response

{
    "session": "session_id"
}

Routes from SSR, SRX and Switch

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.

POST /api/v1/sites/:site_id/devices/:device_id/show_route

Request

{
    // all attributes are optional
    "prefix": "192.168.0.5/30",
    "protocol": "bgp", // bgp (default) / any / ospf / static / direct / evpn
    "vrf": "default",
    "neighbor": "192.168.4.1",
    // if specified, dump both received and advertised
    // for SSR, show bgp neighbors 10.250.18.202 received-routes/advertised-routes
    // for SRX & Switches, show route receive-protocol/advertise-protocol bgp 192.168.255.12
    "route"": "advertised"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

admin@labsystem1.fiedler# show bgp neighbors
BGP neighbor is 192.168.4.1, remote AS 4200000001, local AS 4200000128, external
link
  BGP version 4, remote router ID 1.1.1.1
  BGP state = Established, up for 00:27:25
  Last read 00:00:25, hold time is 90, keepalive interval is 30 seconds
  Configured hold time is 90, keepalive interval is 30 seconds
  Neighbor capabilities:
    4 Byte AS: advertised and received
    Route refresh: advertised and received(old & new)
    Address family IPv4 Unicast: advertised and received
    Graceful Restart Capabilty: advertised and received
      Remote Restart timer is 120 seconds
      Address families by peer:
        none
        ...

BGP summary from SSR, SRX and Switch

Get bgp summary 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_bgp_summary

Request

{
    "node": "node0",
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

Tue 2024-04-23 16:36:06 UTC
Retrieving bgp entries...
BGP table version is 354, local router ID is 10.224.8.16, vrf id 0
Default local pref 100, local AS 65000
Status codes:  s suppressed, d damped, h history, * valid, > best, = multipath,
               i internal, r RIB-failure, S Stale, R Removed
Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self
Origin codes:  i - IGP, e - EGP, ? - incomplete
RPKI validation codes: V valid, I invalid, N Not found

   Network                                      Next Hop                                  Metric LocPrf Weight Path
*> 161.161.161.0/24

OSPF summary from SSR and SRX

Get OSPF summary 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_ospf_summary

Request

{
    "vrf": "lan"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

===== =========== ========== ============= ==================== ========= =========== =============
 Vrf   Router ID   ABR Type   ASBR Router   External LSA Count   Area ID   Area Type   Area Border
                                                                                       Router
===== =========== ========== ============= ==================== ========= =========== =============
       1.0.0.2     cisco            False                    0   0.0.0.0
       1.0.0.2     cisco            False                    0   0.0.0.4   default

OSPF interfaces from SSR and SRX

Get OSPF interfaces 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_ospf_interfaces

Request

{
    "port_id": "ge-0/0/2",
    "vrf": "lan"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

===== ================== =================== ============== =============== =========== ========= ===========
 Vrf   Device Interface   Network Interface   Interface Up   IP Address      OSPF Type   Area ID   Area Type
===== ================== =================== ============== =============== =========== ========= ===========
       net1               g1                          True   172.16.1.2/24   Broadcast   0.0.0.0   default
       net3               g3                          True   172.16.3.2/24   Broadcast   0.0.0.0   default
       net4               g4                          True   172.16.4.2/24   Broadcast   0.0.0.4   default

OSPF Neighbors from SSR and SRX

Get OSPF Neighbors 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_ospf_neighbors

Request

{
    "neighbor": "10.1.1.1",
    "port_id": "ge-0/0/3",
    "vrf": "lan"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

===== ==================== ========== ======= ======== ================ =================== =================
 Vrf   Neighbor Router ID   Priority   State   Uptime   Dead Timer Due   Interface Address   Interface State
===== ==================== ========== ======= ======== ================ =================== =================
       1.0.0.3                     1   Full       852               38   172.16.3.2          Backup
       1.0.0.4                     1   Full       811               33   172.16.3.2          DROther
       1.0.0.3                     1   Full       852               38   172.16.4.2          Backup
       1.0.0.4                     1   Full       811               34   172.16.4.2          DROther

OSPF Database from SSR and SRX

Get OSPF Database 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_ospf_database

Request

{    
    "self_originate": true, // default is false
    "vrf": "lan"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

===== ========= ========== ============ ==================== ====== =================
 Vrf   Area ID   LSA Type   LSA ID       Advertising Router    Age   Sequence Number
===== ========= ========== ============ ==================== ====== =================
       0.0.0.0   Router     1.0.0.2      1.0.0.2, (self)      1264        2147483657
       0.0.0.0   Router     1.0.0.3      1.0.0.3              1265        2147483657
       0.0.0.0   Router     1.0.0.4      1.0.0.4              1264        2147483654
       0.0.0.0   Network    172.16.3.2   1.0.0.2, (self)      1264        2147483650
       0.0.0.0   Summary    172.16.2.0   1.0.0.4              1265        2147483649
       0.0.0.0   Summary    172.16.4.0   1.0.0.2, (self)      1410        2147483649
       0.0.0.0   Summary    172.16.4.0   1.0.0.3              1310        2147483649
       0.0.0.0   Summary    172.16.4.0   1.0.0.4              1255        2147483649
       0.0.0.4   Router     1.0.0.2      1.0.0.2, (self)      1264        2147483654
       0.0.0.4   Router     1.0.0.3      1.0.0.3              1265        2147483654
       0.0.0.4   Router     1.0.0.4      1.0.0.4              1230        2147483657
       0.0.0.4   Network    172.16.4.2   1.0.0.2, (self)      1264        2147483650
       0.0.0.4   Summary    172.16.1.0   1.0.0.2, (self)      1410        2147483649
       0.0.0.4   Summary    172.16.1.0   1.0.0.3              1286        2147483649
       0.0.0.4   Summary    172.16.1.0   1.0.0.4              1255        2147483649
       0.0.0.4   Summary    172.16.3.0   1.0.0.2, (self)      1410        2147483649
       0.0.0.4   Summary    172.16.3.0   1.0.0.3              1310        2147483649
       0.0.0.4   Summary    172.16.3.0   1.0.0.4              1255        2147483649

Service Path from SSR

Get service path information of 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.

POST /api/v1/sites/:site_id/devices/:device_id/show_service_path

Request

{
    // all attributes are optional
    "service_name": "any"
}

Parameters

Response

{
    "session": "session_id"
}

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       Up
Web        web-route2        service-agent     5.5.5.5      2.2.2.2     lan       blue     20    2    50/unlimited   Down
Login      <None>            BgpOverSVR        10.1.1.1     1.2.3.4     wan        red     10    3        -          Up
Login      <None>            BgpOverSVR        11.1.1.1     1.2.3.4     wan        red     10    1        -          Up
App1       <None>            Routed                -           -         -          -      -     -        -          -
App1       learned-routed    Routed                -           -         -          -      -     -        -          -

Sessions from SSR and SRX

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.

POST /api/v1/sites/:site_id/devices/:device_id/show_session

Request

{
    // all attributes are optional
    "service_name": "any"
}

Parameters

Response

{
    "session": "session_id"
}

Example output from ws stream

admin@ssr.node# show sessions
Fri 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


admin@node0.90ec7732e327# show sessions by-id 262900cd-bca8-443a-8aab-e5c93d147ab5
Wed 2024-06-26 20:37:48 UTC
Retrieving session information...

=======================================================================================================================================================================================
 90ec7732e327.node0    Session ID: 262900cd-bca8-443a-8aab-e5c93d147ab5
=======================================================================================================================================================================================
 Service Name:                      Internet
 Service Route Name:                Internet-sr-local-breakout-1-node0
 Session Source:                    SourceType: PUBLIC
 Session Type:                      HTTPS
 Service Class:                     service-class-0-low
 Source Tenant:                     LAN
 Peer Name:                         N/A
 Inter Node:                        N/A
 Inter Router:                      N/A
 Ingress Source Nat:                N/A
 Payload Security Policy:           internal
 Payload Encrypted:                 True
 Common Name Info:                  N/A
 Tcp Time To Establish:             76
 Tls Time To Establish:             76
 Domain Name:                       N/A
 Uri:                               N/A
 Category:                          N/A
...

Subscribe to Device Command outputs

WS /api-ws/v1/stream

Request

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

Response

{
    "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"
    }
}

ARP for the Device

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.

POST /api/v1/sites/:site_id/devices/:device_id/arp

Parameters

Response

{
    "session": "session_id"
}

Subscribe to Device Command outputs

WS /api-ws/v1/stream

Request

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

Response

{
    "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..."
    }
}

Traceroute

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.

POST /api/v1/sites/:site_id/devices/:device_id/traceroute

Request

{
    "host": "1.1.1.1",
    "protocol": "udp",
    "port": 33434,
    "timeout": 120,

    // for SSR, optional, the source to initiate traceroute from. by default, host internal is assumed
    "network": "corp"
    // for SRX, optional, the source to initiate traceroute from. by default, master VRF/RI is assumed
    "vrf": "lan"
}

Parameters

Show ARP Table

Show ARP Table. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/show_arp

Request

{
    // all optional
    "ip": "192.168.30.7”,
    "port_id": "ge-0/0/0.0",
    "vrf": "guest"
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

Show MAC Table

Show MAC Table. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/show_mac_table

Request

{
    "mac": "112233445566”,
    "vlan_id": 1,
    "port_id": "ge-0/0/0.0"
}

Parameters

Clear MAC Table

Clear MAC Table. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/clear_mac_table

Request

{
    "mac": "112233445566”,
    "vlan_id": 1,
    "port_id": "ge-0/0/0.0"
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

Show EVPN Database

Show EVPN Database. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/show_evpn_database

Request

{
    // all optional
    "mac": "f8c1165c6400”,
    "port_id": "ge-0/0/0.0"
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

Show Dot1x Table

Show Dot1x Table. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/show_dot1x

Request

{
    // optional
    "port_id": "ge-0/0/0.0",
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

Clear Dot1x Session

Clear Dot1x Session. The output will be available through websocket.

POST /api/v1/sites/:site_id/devices/:device_id/clear_dot1x

Request

{
    // optional
    "port_id": "ge-0/0/0.0",
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

DNS for SSR Device

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.

 POST /api/v1/sites/:site_id/devices/:device_id/resolve_dns

Response

{
    "session": "session_id"
}

Subscribe to Device Command outputs

WS /api-ws/v1/stream

Request

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

Response

Forwarding table from SSR, SRX and Switch

Get forwarding table from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.

POST /api/v1/sites/:site_id/devices/:device_id/show_forwarding_table

Request

{
    // all optional
    "prefix": "3.1.1.0/24",
    "vrf": "guest",
    "node": "node0",

    // ssr forwarding table has service related information either
    //      by service, or
    "service_name": "internet-wan_and_lte"

    //      by matching (all parameters below needs to be specified)
    "service_tenant": "branch1-wifi-mgt",
    "service_ip": "3.1.1.10",
    "service_port": "32768",
    "service_protocol": "udp"
}

Parameters

• Note: prefix or/and service_name must be used for filtering forwarding table

Response

{
    "session": "session_id"
}

Example output from ws stream

Mon 2024-05-20 16:47:30 UTC
Retrieving fib entries...

Entry Count: 3268
Capacity:    22668

==================== ====== ======= ================== ===== ====================== =========== =========== ======
 IP Prefix            Port   Proto   Tenant             VRF   Service                Next Hops   Vector      Cost
==================== ====== ======= ================== ===== ====================== =========== =========== ======
 0.0.0.0/0               0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10
                                     branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10
                                     branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10
 3.1.1.0/24              0   None    Old_Mgmt           -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10
                                     branch1-Kiosk      -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10
                                     branch1-MGT        -     internet-wan_and_lte   1-2.0       broadband      1
                                                                                     1-4.0       lte           10

Cable Test from Switch

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.

POST /api/v1/sites/:site_id/devices/:device_id/cable_test

Request

{
    "port": "ge-0/0/0"
}

Parameters

Response

{
    "session": "session_id"
}

Subscribe to Cable Test outputs

WS /api-ws/v1/stream

Request

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

Response

{
    "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"
    }
}

Create Shell Session

POST /api/v1/sites/:site_id/devices/:device_id/shell

Request

{
    "node": "node0"
}

Parameters

Response

{
    "session': "19e73828-937f-05e6-f709-e29efdb0a82b",
    "url": "wss://api-ws.mist.com/ssh?jwt=xxxx"
}

Monitor Traffic

Monitor traffic on switches and SRX.

POST /api/v1/sites/:site_id/devices/:device_id/monitor_traffic

Request

{
    "port": "ge-0/0/1"
}

Parameters

JUNOS uses cmd "monitor interface <port>" to monitor traffic on particular <port>
JUNOS uses cmd "monitor interface traffic" to monitor traffic on all ports

Response

{
    "session': "19e73828-937f-05e6-f709-e29efdb0a82b",
    "url": "wss://api-ws.mist.com/ssh?jwt=xxxx"
}

Run top command

Run top command on switches and SRX.

POST /api/v1/sites/:site_id/devices/:device_id/run_top

Response

{
    "session': "19e73828-937f-05e6-f709-e29efdb0a82b"
    "url": "wss://api-ws.mist.com/ssh?jwt=xxxx"
}

Clear BGP routes

Clear routes associated with one or all BGP neighbors

POST /api/v1/sites/:site_id/devices/:device_id/clear_bgp

Request

{
    "neighbor": "all",
    "type": "soft",
    "vrf": "TestVrf"
}

Parameters

Response

Status: 200 OK
Status: 400 - parameter neighbor absent

{
    "session": "session_id"
}

Clear Policy Hit Count for SRX

Clear application policy hit counts for all the policies

POST /api/v1/sites/:site_id/devices/:device_id/clear_policy_hit_count

Response

Status: 200 - OK
Status: 400 - Bad Request

{
    "session": "session_id"
}

Release DHCP lease for SSR Wan Network Interface

Releases an active DHCP lease for SSR wan network interface.

POST /api/v1/sites/:site_id/devices/:device_id/release_dhcp

Request

{
    "port_id": "ge-0/0/1.10"
}

Parameters

Response

Status: 200 OK
Status: 400 - parameter port_id absent

{
    "session": "session_id"
}

Show DHCP leases

Shows DHCP leases. POST /api/v1/sites/:site_id/devices/:device_id/show_dhcp_leases

Request

{
    "network": "guest"
}

Parameters

Response

Status: 200 OK

{
    "session": "session_id"
}

Release leases from DHCP server

Releases active leases from DHCP server. POST /api/v1/sites/:site_id/devices/:device_id/release_dhcp_leases

Request

{
    // all optional
    "port_id": "ge-0/0/1",
    "macs": ["90ec77aabbcc", "90ec77aabbdd"],
    "network": "guest,
}

Parameters

• Note: 1. valid combinations for Junos: [port_id, macs+network], for SSR: [port_id, macs+network, port_id+macs, port_id+network, network] 2. if network or port_id is specified and macs is empty, it means all clients under network or port_id

Clear ARP cache for SSR, SRX and Switch

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

POST /api/v1/sites/:site_id/devices/:device_id/clear_arp

Request

{
    "port_id": "wan",
    "vlan" : 1000,
    "ip" : "10.1.1.1",
    "vrf": "guest"
}

Parameters

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

Response

Status: 200 OK
Status: 400 - port_id must be specified with vlan or ip

{
    "session": "session_id"
}

Clear session for SSR, SRX

Clear session

POST /api/v1/sites/:site_id/devices/:device_id/clear_session

Request

{
    // all optional
    // session deletion by providing service_name to delete all sessions under the service,
    "service_name": "internet-wan_and_lte",

    // or by providing the session id to delete a particular session,
    "session_ids" : [88776655-0123-4567-890a-112233445566],

Parameters

• Note: to use five tuples to lookup the session to be cleared, all must be provided

Response

Status: 200 OK

{
    "session": "session_id"
}

Clear all learned macs from port on Switch

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

POST /api/v1/sites/:site_id/devices/:device_id/clear_macs

Request

{
    "ports": ["ge-0/0/0.0"]
}

Parameters

Response

Status: 200 OK
Status: 400 - logical unit number not specified
Status: 400 - ports not specified

Clear BPDU errors from port(s) on Switch

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.

POST /api/v1/sites/:site_id/devices/:device_id/clear_bpdu_error

Request

{
    "ports": ["ge-0/0/2"]
}

{
    "ports": ["all"]
}

Parameters

Response

Status: 200 OK
Status: 400 - ports not specified

Port Bounce from Switch / Gateway

Port Bounce can be performed from the Switch/Gateway.

POST /api/v1/sites/:site_id/devices/:device_id/bounce_port

Request for bounce ports

{
    "ports": ["ge-0/0/0"]
}

Request for bounce multiple ports

{
    "ports": ["ge-0/0/0", "ge-0/0/1"]
}

Request for bounce a port and multiple ports

{
    "ports": ["ge-0/0/1", "ge-0/0/2"]
}

Parameters

Note: Ports starting with vme, ae, irb, and HA control ports (for SSR only) are not supported

Response

{
    "session": "session_id"
}

Subscribe to Cable Test outputs

WS /api-ws/v1/stream

Request

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

Response

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

Update / Delete Local Switch Port Config

Sometimes HelpDesk Admin needs to change port configs. They can use the following APIs.

PUT /api/v1/sites/:site_id/devices/:device_id/local_port_config
DELETE /api/v1/sites/:site_id/devices/:device_id/local_port_config

Payload

{
    "ge-0/0/5-7": { ... }
}

How does it show up in Device Config?

local_port_config will show up separately from the port_config so it can be easily identified (and cleared)

{
    "local_port_config": {
        "ge-0/0/5-7": {
            ... 
            "note": "force 100M for camera"
        }
    }
}

How to prevent HelpDesk users to overwrite a port config?

no_local_overwrite can be added in port_config. e.g.

{
    "port_config": {
        "ge-0/0/5-7": {
            "usage": "uplink",
            "no_local_overwrite": true
        }
    }
}

Poll Stats Proactively from Switch

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.

POST /api/v1/sites/:site_id/devices/:device_id/poll_stats

Response

Status: 200 OK

Readopt the octerm devices

For the octerm devices, the device ID must come from fpc0. However, for a VC, the users may change the original fpc0 from CLI. To fix the issue, the readopt API could be used to trigger the readopt process so the device would get the corret device ID to connect the cloud.

POST /api/v1/sites/:site_id/devices/:device_id/readopt

Response

Status: 200 OK
Status: 400 - the device is not a virtual chassis

Set IoT Output Pins

Note: For each IoT pin referenced…

1. The pin must be enabled using the Device ‘iot_config’ API
2. The pin must support the output direction

PUT /api/v1/sites/:site_id/devices/:device_id/iot

Request

{
    "DO": 0,
    "A1": 1
}

Response

Status: 200 OK

Get IoT Output Pins

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

GET /api/v1/sites/:site_id/devices/:device_id/iot

Response

{
    "DO": 0,
    "A1": 1
}

Get Available Device Versions

GET /api/v1/sites/:site_id/devices/versions

Response

[
    {
        "model": "AP41",
        "version": "v0.1.543",
        "tag": "stable",
    },
    {
        "model": "AP21",
        "version": "v0.1.545",
    },
    ...
]

Response Schema

Check AP Upgrade Status

When the device is being upgraded, device stat will have the following.

{
    "status": "upgrading",
    "fwupdate": {
        "timestamp": 1428949501,
        "status": "inprogress",
        "status_id": 5,
        "progress": 10
    },
    "auto_upgrade_stat": {
        "scheduled": true,
        "scheduled_version": "1.2.3",
        "scheduled_time": 1428949501
    }
}

the status will be upgrading and a fwupdate object will be added

see also Device Stats

Get AP Radio Channels

Get a list of allowed channels (per channel width)

GET /api/v1/sites/:site_id/devices/ap_channels?country_code=US

Parameters

Response

{
    "key": "US",
    "name": "United States"
    "code": 840,
    "band24_enabled": true,
    "band24_channels": {
        "20": [
            1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
        ],
        "40": [
            1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
        ]
    },
    "band5_enabled": true,
    "dfs_ok": true,
    "band5_channels": {
        "20": [
            36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 132, 136, 140, 149, 153, 157, 161, 165
        ],
        "40": [
            36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 132, 136, 149, 153, 157, 161
        ],
        "80": [
            36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 132, 136, 149, 153, 157, 161
        ],
        "dfs": [
            52, 56, 60, 64, 100, 104, 108, 112, 116, 132, 136, 140
        ],
        "outdoor": [
            "100, 104, 108, 112, 116, 132, 136, 140"
        ]
    }
}

Get Traffic Types

GET /api/v1/const/traffic_types

Response

[
    {
        "name": "data_best_effort",
        "failover_policy": "non-revertible",
        "traffic_class": "low",
        "dscp": 0
    },
    ...
]

Get AP Device Models

Get a list of AP device models for the Mist Site

GET /api/v1/const/device_models

Response

[
    {
        "model": "AP41",
        "display": "AP41",
        "description": "AP-41",
        "ap_type": "aph",
        "fcc_dfs_ok": true,
        "ce_dfs_ok": true,
        "other_dfs_ok": true,
        "has_scanning_radio": true,
        "has_extio": true,
        "extio": {
            "DO": {
                "input": true,
                "default_dir": "OUT",
                "output": true
            },
            "A1": {
                "input": true,
                "default_dir": "IN",
                "output": true
            },
            "A3": {
                "input": true,
                "default_dir": "IN",
                "output": true
            },
            "A2": {
                "input": true,
                "default_dir": "IN",
                "output": true
            },
            "A4": {
                "input": true,
                "default_dir": "IN",
                "output": true
            },
            "DI1": {
                "input": true,
                "default_dir": "IN",
                "output": false
            },
            "DI2": {
                "input": true,
                "default_dir": "IN",
                "output": false
            }
        },
        "has_height": true,
        "has_usb": true,
        "has_wifi_band5": true,
        "has_wifi_band24": true,
        "band5": {
            "max_clients": 128,
            "max_power": 17,
            "min_power": 8
        },
        "band24": {
            "max_clients": 128,
            "max_power": 19,
            "min_power": 8
        },
        "max_poe_out": 6000,
        "has_module_port": true,
        "has_compass": true,
        "has_vble": true,
        "vble": {
            "beacon_rate": 4,
            "power": 8
        }
    }
]

Definition

Get Device Models

Get a list of model definitions (mapping model to its display name, etc)

GET /api/v1/const/device_models

Response

[
    {
        "model": "APH",
        "description": "AP-H, our initial AP with integrated antennas",
        "display": "AP-Premium",
        "has_wifi_band5": true,
        "has_wifi_band24": true,
        "has_scanning_radio": true,
        "has_vble": true,
        "outdoor": false,
        "vble": {
            "power": 8,
            "beacon_rate": 4
        },
        "band24": {
            "max_clients": 128,
            "max_power": 17,
            "min_power": 11
        },
        "band5": {
            "max_clients": 128,
            "max_power": 17,
            "min_power": 11
        },
        "has_compass": true,
        "has_height": true,
        "fcc_dfs_ok": true,
        "ce_dfs_ok": true,
        "other_dfs_ok": true
    }
]

Definition

Note: min_power and max_power are limits that we consider operational (depending on the AP model and testing). And AP may further limit it depending on country/regulatory/channel.

Subscribe to devices Stream

WS /api-ws/v1/stream

Request

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

Response

{
    "event": "data",
    "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/devices",
    "data": {
        "site_id": "67970e46-4e12-11e6-9188-0242ac110007",
        "device_id": "00000000-0000-0000-1000-5c5b3524500b",
        "event_type": "fwupdate",
        "detail": {
            'timestamp': 1485381027,
            'status': 'inprogress,
            'status_id': 4,
            'progress': 45
        }
    }
}

Definition

Subscribe to devices stats Stream

WS /api-ws/v1/stream

Request

{
    "subscribe": "/sites/:site_id/stats/devices"
}

Response

{
    "event": "data",
    "channel": "/sites/67970e46-4e12-11e6-9188-0242ac110007/stats/devices",
    "data": {
        "mac": "5c5b350e1300",
        "version": "0.1.11681",
        "ip": "10.2.10.193",
        "ext_ip": "73.92.124.103",
        "power_src": "PoE 802.3af",
        "uptime": 706659,
        "last_seen": 1504917238,
        "num_clients": 1,
        "num_wlans": 3,
        "ip_stat": {
            // v4
            "ip": "10.2.10.193",
            "netmask": "255.255.192.0",
            "gateway": "10.2.1.1",
            // v6
            "ip6": "2607:f8b0:4005:808::2004",
            "netmask6": "/32",
            "gateway6": "2607:f8b0:4005:808::1",
            "dns": [
                "8.8.8.8",
                "8.8.4.4"
            ],
            "ips": {
                "vlan1": "10.2.1.1/24,2607:f8b0:4005:808::1/32"
            }
        },
        "radio_stat": {
            "band_5": {
                "mac": "5c5b3500bc50",
                "tx_pkts": 29790678,
                "bandwidth": 40,
                "channel": 149,
                "power": 15,
                "tx_bytes": 642844306,
                "rx_pkts": 214935,
                "rx_bytes": 28557893,
                "num_wlans": 1,
                "num_clients": 1
            },
            "band_24": {
                "mac": "5c5b3500bc40",
                "tx_pkts": 19831714,
                "bandwidth": 20,
                "channel": 11,
                "power": 11,
                "tx_bytes": 3118012867,
                "rx_pkts": 3,
                "rx_bytes": 298,
                "num_wlans": 1,
                "num_clients": 0
            },
            "band_6": {
                "mac": "5c5b3500bc60",
                "tx_pkts": 29790678,
                "bandwidth": 40,
                "channel": 53,
                "power": 15,
                "tx_bytes": 642844306,
                "rx_pkts": 214935,
                "rx_bytes": 28557893,
                "num_wlans": 1,
                "num_clients": 1
            },            
        },
        "port_stat": {
            "module": {
                "tx_pkts": 6413453,
                "rx_pkts": 951238,
                "rx_bytes": 877498272,
                "tx_bytes": 1009414543,
                "rx_peak_bps": 31116,
                "tx_peak_bps": 42165,
                "full_duplex": true,
                "speed": 1000,
                "up": true,
                "rx_errors": 0
            },
            "eth3": {
                "tx_pkts": 0,
                "rx_pkts": 0,
                "rx_bytes": 0,
                "tx_bytes": 0,
                "rx_peak_bps": 0,
                "tx_peak_bps": 0,
                "full_duplex": false,
                "speed": 0,
                "up": false,
                "rx_errors": 0
            },
            "eth2": {
                "tx_pkts": 0,
                "rx_pkts": 0,
                "rx_bytes": 0,
                "tx_bytes": 0,
                "rx_peak_bps": 0,
                "tx_peak_bps": 0,
                "full_duplex": false,
                "speed": 0,
                "up": false,
                "rx_errors": 0
            },
            "eth1": {
                "tx_pkts": 0,
                "rx_pkts": 0,
                "rx_bytes": 0,
                "tx_bytes": 0,
                "rx_peak_bps": 0,
                "tx_peak_bps": 0,
                "full_duplex": false,
                "speed": 0,
                "up": false,
                "rx_errors": 0
            },
            "eth0": {
                "tx_pkts": 2731519,
                "rx_pkts": 8325448,
                "rx_bytes": 3224888514,
                "tx_bytes": 2116882740,
                "rx_peak_bps": 482729,
                "tx_peak_bps": 293857,
                "full_duplex": true,
                "speed": 1000,
                "up": true,
                "rx_errors": 0
            }
        },
        "lldp_stat": {
            "system_name": "TC2-OWL-Stack-01",
            "system_desc": "HP J9729A 2920-48G-POE+ Switch",
            "mgmt_addr": "10.1.5.2",
            "lldp_med_supported": false,
            "port_desc": "",
            "port_id": "",
            "power_request_count": 0,
            "power_allocated": 0,
            "power_draw": 0,
            "power_requested": 0
        },
        "l2tp_stat": {
        },
        "rx_bytes": 28558191,
        "rx_pkts": 214938,
        "tx_pkts": 49622392,
        "tx_bytes": 3760857173,
        "tx_bps": 0,
        "rx_bps": 0,
        "cpu_stat": {
            "system": 5,
            "idle": 81,
            "interrupt": 0,
            "user": 14,
            "load_avg": [
                0.14,
                0.23,
                0.24
            ]
        },
        "memory_stat": {
            "usage": 33
        },
    }
}

Search AP

 GET /api/v1/sites/:site_id/devices/search?ip=10.2.16.205

Supported Filters

Response

{
    "results": [
        {
            "mac": "5c5b353e5299",
            "model": "AP41",
            "sku": "AP41-US",
            "ip": "10.2.16.205",
            "version": "0.7.20216",
            "uptime": 85280,
            "org_id": "6748cfa6-4e12-11e6-9188-0242ac110007",
            "site_id": "a8178443-ecb5-461c-b854-f16627619ab3",
            "mxedge_id": "00000000-0000-0000-1000-43a81f238391",
            "mxedge_ids": [
                "00000000-0000-0000-1000-43a81f238391"
            ],
            "mxtunnel_status": "down",
            "hostname": [
                            "AP41-STB-3E5299-WH-2001",
                            "AP41-STB-3E5299-WH-50",
                            "AP41-STB-3E5299",
                            "5c5b353e5299"
                        ],
            "lldp_port_desc": "GigabitEthernet1/0/1",
            "lldp_mgmt_addr": "10.2.10.139",
            "lldp_system_desc": "Cisco IOS Software, C2960S Software (C2960S-UNIVERSALK9-M), Version 15.2(1)E1, RELEASE SOFTWARE (fc2)\nTechnical Support: http://www.cisco.com/techsupport\nCopyright (c) 1986-2013 by Cisco Systems, Inc.\nCompiled Fri 22-Nov-13 07:10 by prod_rel_team",
            "lldp_system_name": "ME-DC-1-ACC-SW",
            "lldp_port_id": "Gi1/0/1",
            "timestamp": 1596588619.007
        }
    ]
}

Supported Filters for device type Switch or Gateway

radius_stats

Response for device type Switch or Gateway

{
    "results": [
        {
            "ip": "192.168.86.22",
            "type": "switch",
            "version": "21.4R1.12",
            "mac": "3c8c939485ad",
            "uptime": 2380356,
            "ext_ip": "0.0.0.0",
            "hostname": [
                "3c8c939485ad",
                "ludi-ex2300"
            ],
            "timestamp": 1661273225.321,
            "org_id": "6748cfa6-4e12-11e6-9188-0242ac110007",
            "num_members": 1,
            "site_id": "8721e817-96ee-4e34-b6b6-a80cc01642a6",
            "model": "ex2300-c-12p",
            "last_hostname": "3c8c939485ad"
            "last_config_status": "success",
            "radius_stats": {
              "192.168.1.10": {
                "auth_accepts": 120,
                "auth_rejects": 5,
                "auth_timeouts": 0,
                "auth_server_status": "up"
              },
              "192.168.1.11": {
                "auth_accepts": 110,
                "auth_rejects": 15,
                "auth_timeouts": 2,
                "auth_server_status": "unreachable"
              }
            }
        }
    ]
}

Count AP

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

GET /api/v1/sites/:site_id/devices/count?distinct=type&start=1531776183&end=1531862583&limit=10

Response

{
    "end": 1531862583.0,
    "distinct": "version",
    "results": [
        {
            "count": 10,
            "version": "apfw-0.5.16833-ellaria-0455"
        },
        {
            "count": 4,
            "type": "apfw-0.3.14833-cersei-0455"
        }
    ],
    "start": 1531776183.0,
    "limit": 10,
    "total": 2
}

Search Device Config History

GET /api/v1/sites/:site_id/devices/config_history/search?mac=5c5b350e0001&start=1531776183&end=1531862583&limit=10

Response

{
    "total": 1,
    "start": 1531776183.0,
    "limit": 10,
    "end": 1531862583.0,
    "results": [
        {
            "channel_5": 100,
            "ssids_24": [
                "test24",
            ],
            "radios": [
                {
                    "band": "24",
                    "channel": 11
                },
                {
                    "band": "5",
                    "channel": 100
                }
            ],
            "timestamp": 1531855856.643369,
            "version": "apfw-0.2.14754-cersei-75c8",
            "channel_24": 11,
            "ssids": [
                "test24",
                "test5",
                "test6"
            ],
            "wlans": [
                {
                    "id": "be22bba7-8e22-e1cf-5185-b880816fe2cf",
                    "bands": [
                        "24",
                    ],
                    "vlan_ids": [
                        "1"
                    ],
                    "ssid": "test24",
                    "auth": "psk"
                },
                {
                    "id": "f8c18724-4118-3487-811a-f98964988604",
                    "bands": [
                        "5"
                    ],
                    "vlan_ids": [
                        "1"
                    ],
                    "ssid": "test5",
                    "auth": "psk"
                },
                { 
                    "id": "f8c18724-4118-3487-811a-f98964988605",
                    "bands": [
                        "6"
                    ],
                    "vlan_ids": [
                        "1"
                    ],
                    "ssid": "test6",
                    "auth": "psk"
                }
            ],
            "radio_macs": [
                "5c5b352e000a",
                "5c5b352e000b",
                "5c5b352e000c"
            ],
            "ssids_5": [
                "test5"
            ],
            "ssids_6": [
                "test6"
            ],
            "channel_6": 85,
            "secpolicy_violated": false
        }
    ]
}

Count Device Config History

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

GET /api/v1/sites/:site_id/devices/config_history/count?distinct=mac&start=1531776183&end=1531862583&limit=10

Response

{
    "end": 1531862583,
    "distinct": "ap",
    "results": [
        {
            "count": 1,
            "ap": "5c5b350e0001"
        },
        {
            "count": 5,
            "ap": "5c5b350e0002"
        },
        {
            "count": 5,
            "ap": "5c5b350e0003"
        }
    ],
    "start": 1531776183,
    "limit": 10,
    "total": 3
}

Search Device Last Configs

GET /api/v1/sites/:site_id/devices/last_config/search?mac=5c5b350e0001&start=1531776183&end=1531862583&limit=10

Request Parameters