{
"opencollection": "1.0.0",
"info": {
"name": "Mist API",
"version": "2604.1.1"
},
"request": {
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Constants Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "listAlarmDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/alarm_defs"
},
"docs": "Get List of brief definitions of all the supported alarm types. The example field contains an example payload as you would receive in the alarm webhook output.\nHA cluster node names will be specified in the `node` field, if applicable."
},
{
"info": {
"name": "listClientEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/client_events"
},
"docs": "Get List of List of available Client Events"
},
{
"info": {
"name": "listDeviceEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/device_events"
},
"docs": "Get list of available Device Events"
},
{
"info": {
"name": "listMxEdgeEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/mxedge_events"
},
"docs": "Get List of available MX Edge Events"
},
{
"info": {
"name": "listNacEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/nac_events"
},
"docs": "Get List of List of available NAC Client Events"
},
{
"info": {
"name": "listOtherDeviceEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/otherdevice_events"
},
"docs": "Supported Events Type"
},
{
"info": {
"name": "listSystemEventsDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/system_events"
},
"docs": "Get List of List of available System Events"
}
]
},
{
"info": {
"name": "Constants Definitions",
"type": "folder"
},
"items": [
{
"info": {
"name": "listApChannels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/ap_channels",
"params": [
{
"name": "country_code",
"value": "",
"type": "query",
"description": "Country code, in two-character"
}
]
},
"docs": "Get List of List of Available channels per country code"
},
{
"info": {
"name": "listApLEslVersions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/ap_esl_versions"
},
"docs": "Get Available AP ESL Versions"
},
{
"info": {
"name": "listApLedDefinition",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/ap_led_status"
},
"docs": "Get List of AP LED definition"
},
{
"info": {
"name": "listAppCategoryDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/app_categories"
},
"docs": "Get List of definitions of all the supported Application Categories. The example field contains an example payload as you would receive in the alarm webhook output."
},
{
"info": {
"name": "listAppSubCategoryDefinitions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/app_subcategories"
},
"docs": "Get List of definitions of all the supported Application sub-categories. The example field contains an example payload as you would receive in the alarm webhook output."
},
{
"info": {
"name": "listApplications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/applications"
},
"docs": "Get List of a list of applications that Juniper-Mist APs recognize"
},
{
"info": {
"name": "listCountryCodes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/countries",
"params": [
{
"name": "extend",
"value": "",
"type": "query",
"description": "Will include more country codes if true"
}
]
},
"docs": "Get List of available Country Codes"
},
{
"info": {
"name": "listFingerprintTypes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/fingerprint_types"
},
"docs": "Get List of supported fingerprint attribute values\n* family\n* model\n* mfg\n* os_type\n\nThis information can be used in the [Mist NAC Rules]($h/Orgs%20NAC%20Rules/_overview) `matching` attribute."
},
{
"info": {
"name": "listGatewayApplications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/gateway_applications"
},
"docs": "Get the full list of applications that we recognize"
},
{
"info": {
"name": "listInsightMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/insight_metrics"
},
"docs": "List Insight Metrics"
},
{
"info": {
"name": "listSiteLanguages",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/languages"
},
"docs": "Get List of Languages"
},
{
"info": {
"name": "listLicenseTypes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/license_types"
},
"docs": "Get License Types"
},
{
"info": {
"name": "listMarvisClientVersions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/marvisclient_versions"
},
"docs": "Get List of the available Marvis Client Versions."
},
{
"info": {
"name": "listStates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/states",
"params": [
{
"name": "country_code",
"value": "",
"type": "query",
"description": "Country code, in [two-character](/#operations/listCountryCodes)"
}
]
},
"docs": "Get List of ISO States based on country code"
},
{
"info": {
"name": "listTrafficTypes",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/traffic_types"
},
"docs": "Get List of identified traffic"
},
{
"info": {
"name": "listWebhookTopics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/webhook_topics"
},
"docs": "Get List of the available Webhook Topics."
}
]
},
{
"info": {
"name": "Constants Models",
"type": "folder"
},
"items": [
{
"info": {
"name": "getGatewayDefaultConfig",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/default_gateway_config",
"params": [
{
"name": "model",
"value": "",
"type": "query",
"description": "Model the default gateway config is intended (as the default LAN/WAN port can differ)"
},
{
"name": "ha",
"value": "",
"type": "query",
"description": "Whether the config is intended for HA"
}
]
},
"docs": "Generate Default Gateway Config"
},
{
"info": {
"name": "listDeviceModels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/device_models"
},
"docs": "Get list of AP device models for the Mist Site"
},
{
"info": {
"name": "listMxEdgeModels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/mxedge_models"
},
"docs": "Get List of available Mx Edge models"
},
{
"info": {
"name": "listSupportedOtherDeviceModels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/const/otherdevice_models"
},
"docs": "Supported OtherDevice Models"
}
]
},
{
"info": {
"name": "Installer",
"type": "folder"
},
"items": [
{
"info": {
"name": "listInstallerAlarmTemplates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/alarmtemplates",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of alarm templates"
},
{
"info": {
"name": "listInstallerDeviceProfiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/deviceprofiles",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Device Profiles"
},
{
"info": {
"name": "listInstallerListOfRecentlyClaimedDevices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device Model"
},
{
"name": "site_name",
"value": "",
"type": "query",
"description": "Site Name"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site ID"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of recently claimed devices"
},
{
"info": {
"name": "claimInstallerDevices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This mirrors `POST /api/v1/orgs/{org_id}/inventory` (see Inventory API)"
},
{
"info": {
"name": "provisionInstallerDevices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Provision or Replace a device \n\nIf replacing_mac is in the request payload, other attributes are ignored, we attempt to replace existing device (with mac replacing_mac) with the inventory device being configured. The replacement device must be in the inventory but not assigned, and the replacing_mac device must be assigned to a site, and satisfy grace period requirements. The Device replaced will become unassigned."
},
{
"info": {
"name": "unassignInstallerRecentlyClaimedDevice",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Unassign recently claimed devices"
},
{
"info": {
"name": "startInstallerLocateDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac/locate",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Locate a Device by blinking it’s LED, it’s a persisted state that has to be stopped by calling Stop Locating API"
},
{
"info": {
"name": "stopInstallerLocateDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac/unlocate",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Stop it"
},
{
"info": {
"name": "addInstallerDeviceImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac/:image_name",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "image_name",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Add image"
},
{
"info": {
"name": "deleteInstallerDeviceImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:device_mac/:image_name",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "image_name",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Delete image"
},
{
"info": {
"name": "getInstallerDeviceVirtualChassis",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:fpc0_mac/vc",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "fpc0_mac",
"value": "",
"type": "path",
"description": "FPC0 MAC Address"
}
]
},
"docs": "Get VC Status\n\nThe API returns a combined view of the VC status which includes topology and stats"
},
{
"info": {
"name": "createInstallerVirtualChassis",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:fpc0_mac/vc",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "fpc0_mac",
"value": "",
"type": "path",
"description": "FPC0 MAC Address"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory.\n\nIn case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn't have dedicated VC ports, below are procedures to automate the VC creation:\n\n1. Power on the switch that is chosen as the VC master first. And then powering on the other membe"
},
{
"info": {
"name": "updateInstallerVirtualChassisMember",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/devices/:fpc0_mac/vc",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "fpc0_mac",
"value": "",
"type": "path",
"description": "FPC0 MAC Address"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config.\n\nIn this config, fpc0 has to be the same as the mac of device_id. Use renu"
},
{
"info": {
"name": "listInstallerRfTemplatesNames",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/rftemplates",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of RF Templates"
},
{
"info": {
"name": "listInstallerSiteGroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sitegroups",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Site Groups"
},
{
"info": {
"name": "listInstallerSites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Sites"
},
{
"info": {
"name": "createOrUpdateInstallerSites",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Often the Installers are asked to assign Devices to Sites. The Sites can either be pre-created or created/modified by the Installer. If this is an update, the same grace period also applies."
},
{
"info": {
"name": "listInstallerMaps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name/maps",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Maps"
},
{
"info": {
"name": "importInstallerMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name/maps/import",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign & place ap if name or mac matches"
},
{
"info": {
"name": "createInstallerMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name/maps/:map_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a MAP"
},
{
"info": {
"name": "updateInstallerMap",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name/maps/:map_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update map"
},
{
"info": {
"name": "deleteInstallerMap",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/installer/orgs/:org_id/sites/:site_name/maps/:map_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Map"
},
{
"info": {
"name": "optimizeInstallerRrm",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/installer/sites/:site_name/optimize",
"params": [
{
"name": "site_name",
"value": "",
"type": "path"
}
]
},
"docs": "After installation is considered complete (APs are placed on maps, all powered up), you can trigger an optimize operation where RRM will kick in (and maybe other things in the future) before it’s automatically scheduled."
}
]
},
{
"info": {
"name": "Admins",
"type": "folder"
},
"items": [
{
"info": {
"name": "verifyAdminInvite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/invite/verify/:token",
"params": [
{
"name": "token",
"value": "",
"type": "path"
}
]
},
"docs": "**Note**: another call to ```GET /api/v1/self``` is required to see the new set of privileges"
},
{
"info": {
"name": "registerNewAdmin",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/register",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Register a new admin and his/her org\nAn email will also be sent to the user with a link to `/verify/register?token={token}`\n\n### reCAPTCHA\nGoogle reCAPTCHA is the choice to prevent bot registration\n\nIt needs this \n\n<script src='https://www.google.com/recaptcha/api.js' ></script>\n\nand this <div> in the desired place\n```html\n\n```\n\nUse GET /api/v1/register/recaptcha to read the current setting.\n"
},
{
"info": {
"name": "getAdminRegistrationInfo",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/register/recaptcha",
"params": [
{
"name": "recaptcha_flavor",
"value": "",
"type": "query"
}
]
},
"docs": "Get Registration Information"
},
{
"info": {
"name": "verifyRegistration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/register/verify/:token",
"params": [
{
"name": "token",
"value": "",
"type": "path"
}
]
},
"docs": "Verify registration"
}
]
},
{
"info": {
"name": "Admins Login",
"type": "folder"
},
"items": [
{
"info": {
"name": "login",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/login",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Log in with email/password.\nWhen 2FA is enabled, there are two ways to login:\n1. login with two_factor token (with Google Authenticator, etc) \n2. login with email/password, generate the token, and use /login/two_factor with the token"
},
{
"info": {
"name": "twoFactor",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/login/two_factor",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send 2FA Code"
}
]
},
{
"info": {
"name": "Admins Lookup",
"type": "folder"
},
"items": [
{
"info": {
"name": "lookup",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/login/lookup",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Login Lookup"
}
]
},
{
"info": {
"name": "Admins Login - OAuth2",
"type": "folder"
},
"items": [
{
"info": {
"name": "getOauth2AuthorizationUrlForLogin",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/login/oauth/:provider",
"params": [
{
"name": "provider",
"value": "",
"type": "path"
},
{
"name": "forward",
"value": "",
"type": "query",
"description": "Callback URL"
}
]
},
"docs": "Obtain Authorization URL for Login"
},
{
"info": {
"name": "loginOauth2",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/login/oauth/:provider",
"params": [
{
"name": "provider",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Login via OAuth2"
},
{
"info": {
"name": "unlinkOauth2Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/login/oauth/:provider",
"params": [
{
"name": "provider",
"value": "",
"type": "path"
}
]
},
"docs": "Unlink OAuth2 Provider"
}
]
},
{
"info": {
"name": "Admins Logout",
"type": "folder"
},
"items": [
{
"info": {
"name": "logout",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/logout"
},
"docs": "Logout"
}
]
},
{
"info": {
"name": "Orgs SDK Invites",
"type": "folder"
},
"items": [
{
"info": {
"name": "activateSdkInvite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/mobile/verify/:secret",
"params": [
{
"name": "secret",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Verify secret"
},
{
"info": {
"name": "listSdkInvites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Org SDK Invites"
},
{
"info": {
"name": "createSdkInvite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create SDK Invite"
},
{
"info": {
"name": "getSdkInvite",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get SDK Invite Details"
},
{
"info": {
"name": "updateSdkInvite",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update SDK Invite"
},
{
"info": {
"name": "revokeSdkInvite",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Revoke SDK Invite"
},
{
"info": {
"name": "sendSdkInviteEmail",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/email",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send SDK Invite by Email"
},
{
"info": {
"name": "getSdkInviteQrCode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/qrcode",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Revoke SDK Invite"
},
{
"info": {
"name": "sendSdkInviteSms",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/sms",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sdkinvite_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send SDK Invite by SMS"
}
]
},
{
"info": {
"name": "MSPs",
"type": "folder"
},
"items": [
{
"info": {
"name": "createMsp",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MSP account"
},
{
"info": {
"name": "getMspDetails",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP Detail"
},
{
"info": {
"name": "updateMsp",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP"
},
{
"info": {
"name": "deleteMsp",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Deleting MSP removes the MSP and OrgGroup under the MSP as well as all privileges associated with them. It does not remove any Org or Admins"
},
{
"info": {
"name": "searchMspOrgGroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/search",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "orgs",
"type": "query",
"description": "Orgs"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Search string"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
}
]
},
"docs": "Search in MSP Orgs"
}
]
},
{
"info": {
"name": "MSPs Admins",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspAdmins",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/admins",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP Admins"
},
{
"info": {
"name": "getMspAdmin",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/admins/:admin_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "admin_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP Admins"
},
{
"info": {
"name": "updateMspAdmin",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/admins/:admin_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "admin_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP Admin"
},
{
"info": {
"name": "revokeMspAdmin",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/admins/:admin_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "admin_id",
"value": "",
"type": "path"
}
]
},
"docs": "This removes all privileges this admin has against the MSP. This goes deep all the way to the sites"
},
{
"info": {
"name": "inviteMspAdmin",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/invites",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Invite MSP Admin\n\n**Note**: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token"
},
{
"info": {
"name": "updateMspAdminInvite",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/invites/:invite_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "invite_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP admin invite"
},
{
"info": {
"name": "uninviteMspAdmin",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/invites/:invite_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "invite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete admin invite"
}
]
},
{
"info": {
"name": "MSPs Licenses",
"type": "folder"
},
"items": [
{
"info": {
"name": "claimMspLicense",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/claim",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Claim an Order by Activation Code"
},
{
"info": {
"name": "listMspLicenses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/licenses",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Msp Licenses"
},
{
"info": {
"name": "moveOrDeleteMspLicenseToAnotherOrg",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/licenses",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Move or Delete MSP Licenses"
},
{
"info": {
"name": "listMspOrgLicenses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/stats/licenses",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP Licenses"
}
]
},
{
"info": {
"name": "MSPs SLEs",
"type": "folder"
},
"items": [
{
"info": {
"name": "getMspSle",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/insights/:metric",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for available metrics"
},
{
"name": "sle",
"value": "",
"type": "query",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for more details"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get MSP SLEs (all/worst Orgs ...)"
}
]
},
{
"info": {
"name": "MSPs Inventory",
"type": "folder"
},
"items": [
{
"info": {
"name": "getMspInventoryByMac",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/inventory/:device_mac",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Get Inventory By device MAC address"
}
]
},
{
"info": {
"name": "MSPs Logo",
"type": "folder"
},
"items": [
{
"info": {
"name": "postMspLogo",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/logo",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upload Logo (only for advanced msp tier)"
},
{
"info": {
"name": "deleteMspLogo",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/logo",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete MSP Logo"
}
]
},
{
"info": {
"name": "MSPs Logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspAuditLogs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/logs",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id"
},
{
"name": "admin_name",
"value": "",
"type": "query",
"description": "Admin name or email"
},
{
"name": "message",
"value": "",
"type": "query",
"description": "Message"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort order"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get list of change logs for the current MSP"
},
{
"info": {
"name": "countMspAuditLogs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/logs/count",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Audit Logs."
}
]
},
{
"info": {
"name": "MSPs Org Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspOrgGroups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orggroups",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP Org Groups"
},
{
"info": {
"name": "createMspOrgGroup",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orggroups",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MSP Org Group"
},
{
"info": {
"name": "getMspOrgGroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orggroups/:orggroup_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "orggroup_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP Org Group Details"
},
{
"info": {
"name": "updateMspOrgGroup",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orggroups/:orggroup_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "orggroup_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP Org Group"
},
{
"info": {
"name": "deleteMspOrgGroup",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orggroups/:orggroup_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "orggroup_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete MSP Org Group"
}
]
},
{
"info": {
"name": "MSPs Orgs",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspOrgs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP Orgs"
},
{
"info": {
"name": "createMspOrg",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create an Org under MSP"
},
{
"info": {
"name": "manageMspOrgs",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign or Unassign Orgs to an MSP account"
},
{
"info": {
"name": "searchMspOrgs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs/search",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "name",
"value": "",
"type": "query"
},
{
"name": "org_id",
"value": "",
"type": "query",
"description": "Org id"
},
{
"name": "sub_insufficient",
"value": "",
"type": "query",
"description": "If this org has sufficient subscription"
},
{
"name": "trial_enabled",
"value": "",
"type": "query",
"description": "If this org is under trial period"
},
{
"name": "usage_types",
"value": "",
"type": "query",
"description": "List of types that enabled by usage"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org in MSP"
},
{
"info": {
"name": "getMspOrg",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs/:org_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP Org Details"
},
{
"info": {
"name": "updateMspOrg",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs/:org_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP Org"
},
{
"info": {
"name": "deleteMspOrg",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/orgs/:org_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete MSP Org"
},
{
"info": {
"name": "listMspOrgStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/stats/orgs",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of MSP Orgs Stats"
}
]
},
{
"info": {
"name": "MSPs SSO Roles",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspSsoRoles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssoroles",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP SSO Roles"
},
{
"info": {
"name": "createMspSsoRole",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssoroles",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MSP Role"
},
{
"info": {
"name": "updateMspSsoRole",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssoroles/:ssorole_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "ssorole_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update SSO Role"
},
{
"info": {
"name": "deleteMspSsoRole",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssoroles/:ssorole_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "ssorole_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete MSP SSO Roles"
}
]
},
{
"info": {
"name": "MSPs SSO",
"type": "folder"
},
"items": [
{
"info": {
"name": "listMspSsos",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
]
},
"docs": "List MSP SSO Configs"
},
{
"info": {
"name": "createMspSso",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MSP SSO profile"
},
{
"info": {
"name": "getMspSso",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP SSO Config"
},
{
"info": {
"name": "updateMspSso",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update MSP SSO config"
},
{
"info": {
"name": "deleteMspSso",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete MSP SSO Config"
},
{
"info": {
"name": "deleteMspSsoAdmins",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id/delete_admins",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete MSP SSO Admin users by email. This removes SSO-linked admin accounts from the organization."
},
{
"info": {
"name": "listMspSsoLatestFailures",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id/failures",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of MSP SSO Latest Failures"
},
{
"info": {
"name": "getMspSamlMetadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id/metadata",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get MSP SAML Metadata"
},
{
"info": {
"name": "downloadMspSamlMetadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/msps/:msp_id/ssos/:sso_id/metadata.xml",
"params": [
{
"name": "msp_id",
"value": "",
"type": "path"
},
{
"name": "sso_id",
"value": "",
"type": "path"
}
]
},
"docs": "Download MSP SAML Metadata\n\nExample of metadata.xml:\n```xml\n\n \n (string): IP address of the RADIUS server as the key\n * `auth_accepts` (long): Number of accepted authentication requests\n * `auth_rejects` (long): Number of rejected authentication requests\n * `auth_timeouts` (long): Number of authentication timeouts\n * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id"
},
{
"name": "stats",
"value": "",
"type": "query",
"description": "Whether to return device stats"
},
{
"name": "t128agent_version",
"value": "",
"type": "query",
"description": "When `type`==`gateway` (SSR only), version of 128T agent"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of device. enum: `ap`, `gateway`, `switch`"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Version"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org Devices"
},
{
"info": {
"name": "listOrgDevicesSummary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/summary",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org Devices Summary"
},
{
"info": {
"name": "getOrgJuniperDevicesCommand",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ocdevices/outbound_ssh_cmd",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site_id would be used for proxy config check of the site and automatic site assignment"
}
]
},
"docs": "Get Org Juniper Devices command\n\nJuniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used.\nA few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist."
}
]
},
{
"info": {
"name": "Utilities Upgrade",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgDeviceUpgrades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Org multiple devices upgrades"
},
{
"info": {
"name": "upgradeOrgDevices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Multiple Sites (Only supported for Access Points upgrades)"
},
{
"info": {
"name": "getOrgDeviceUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/upgrade/:upgrade_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Multiple Devices Upgrade"
},
{
"info": {
"name": "cancelOrgDeviceUpgrade",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Best effort to cancel an upgrade. Devices which are already upgraded wont be touched"
},
{
"info": {
"name": "listOrgAvailableDeviceVersions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/devices/versions",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Fetch version for device model, use/combine with `type` as needed (for switch and gateway devices)"
}
]
},
"docs": "Get List of Available Device Versions"
},
{
"info": {
"name": "upgradeOrgJsiDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/devices/:device_mac/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade"
},
{
"info": {
"name": "listOrgMxEdgeUpgrades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Org Mist Edge Upgrades"
},
{
"info": {
"name": "upgradeOrgMxEdges",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Mist Edges"
},
{
"info": {
"name": "getOrgMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/upgrade/:upgrade_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Mist Edge Upgrade"
},
{
"info": {
"name": "updateOrgMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/upgrade/:upgrade_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Mist Edge Upgrade. Only upgrades in `queued` state can be updated."
},
{
"info": {
"name": "cancelOrgMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Cancel Mist Edge Upgrade. Best effort to cancel an upgrade. Devices which are already upgraded won't be touched."
},
{
"info": {
"name": "listOrgSsrUpgrades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ssr/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Org SSR Upgrades"
},
{
"info": {
"name": "upgradeOrgSsrs",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ssr/upgrade",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Org SSRs"
},
{
"info": {
"name": "getOrgSsrUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ssr/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Specific Org SSR Upgrade"
},
{
"info": {
"name": "cancelOrgSsrUpgrade",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ssr/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Best effort to cancel an upgrade. Devices which are already upgraded wont be touched↵\n"
},
{
"info": {
"name": "listOrgAvailableSsrVersions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/ssr/versions",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "SSR version channel"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Optional. MAC address, or comma separated MAC address list."
}
]
},
"docs": "Get available version for SSR"
},
{
"info": {
"name": "listSiteDeviceUpgrades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "status",
"value": "",
"type": "query"
}
]
},
"docs": "Get all upgrades for site"
},
{
"info": {
"name": "upgradeSiteDevices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Site Device\n\n**Note**: this call doesn’t guarantee the devices to be upgraded right away (they may be offline)"
},
{
"info": {
"name": "getSiteDeviceUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade/:upgrade_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Device Upgrade"
},
{
"info": {
"name": "cancelSiteDeviceUpgrade",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Best effort to cancel an upgrade. Devices which are already upgraded wont be touched"
},
{
"info": {
"name": "listSiteAvailableDeviceVersions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/versions",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Fetch version for device model, use/combine with `type` as needed (for switch and gateway devices)"
}
]
},
"docs": "Get List of Available Device Versions"
},
{
"info": {
"name": "upgradeDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Device Upgrade"
},
{
"info": {
"name": "listSiteMxEdgeUpgrades",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Site Mist Edge Upgrades"
},
{
"info": {
"name": "upgradeSiteMxEdges",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Mist Edges in a Site.\n\nSee [Org Mist Edges](/#tag/Utilities-Upgrade/operation/upgradeOrgMxEdges) for package upgrades\n\nSee [Org Mist Edges Distro](/#tag/Utilities-Upgrade/operation/upgradeOrgMxEdges) for distro upgrades"
},
{
"info": {
"name": "getSiteMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/upgrade/:upgrade_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Mist Edge Upgrade"
},
{
"info": {
"name": "updateSiteMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/upgrade/:upgrade_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Mist Edge Upgrade. Only upgrades in `queued` state can be updated."
},
{
"info": {
"name": "cancelSiteMxEdgeUpgrade",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/upgrade/:upgrade_id/cancel",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Cancel Mist Edge Upgrade. Best effort to cancel an upgrade. MxEdges which are already upgraded won't be touched."
},
{
"info": {
"name": "getSiteSsrUpgrade",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/ssr/upgrade/:upgrade_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "upgrade_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Specific Site SSR Upgrade"
},
{
"info": {
"name": "upgradeSsr",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/ssr/:device_id/upgrade",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade Site SSR device"
}
]
},
{
"info": {
"name": "Orgs Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "searchOrgEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/events/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org events\n\n\nSupported Event Types:\n- CRADLEPOINT_SYNC_FAILED\n- ORG_CA_CERT_ADDED\n- ORG_CA_CERT_REGENERATED"
},
{
"info": {
"name": "countOrgSystemEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/events/system/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Count Org System Events"
},
{
"info": {
"name": "searchOrgSystemEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/events/system/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org System Events"
}
]
},
{
"info": {
"name": "Orgs EVPN Topologies",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgEvpnTopologies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/evpn_topologies",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "for_site",
"value": "",
"type": "query",
"description": "Filter for org/site level EVPN Toplogies"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of the existing Org EVPN topologies"
},
{
"info": {
"name": "createOrgEvpnTopology",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/evpn_topologies",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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.\n\n**Notes:**\n1. You can use `core` / `distribution` / `access` to create a CLOS topology\n2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switc"
},
{
"info": {
"name": "getOrgEvpnTopology",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get One EVPN Topology Detail"
},
{
"info": {
"name": "updateOrgEvpnTopology",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the EVPN Topology"
},
{
"info": {
"name": "deleteOrgEvpnTopology",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete the Org EVPN Topology"
}
]
},
{
"info": {
"name": "Orgs Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "getOrgE911Report",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/exports/e911_report",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the status of E911 AP BSSID reports and download URL if available."
},
{
"info": {
"name": "enableOrgE911Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/exports/e911_report",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Enable automatic E911 AP BSSID report generation for the organization. Reports will be generated immediately and then every 24 hours."
},
{
"info": {
"name": "disableOrgE911Report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/exports/e911_report",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Disable automatic E911 AP BSSID report generation for the organization."
}
]
},
{
"info": {
"name": "Orgs Gateway Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgGatewayTemplates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/gatewaytemplates",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Org Gateway Templates"
},
{
"info": {
"name": "createOrgGatewayTemplate",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/gatewaytemplates",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Org Gateway Template"
},
{
"info": {
"name": "getOrgGatewayTemplate",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/gatewaytemplates/:gatewaytemplate_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "gatewaytemplate_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Organization Gateway Template details"
},
{
"info": {
"name": "updateOrgGatewayTemplate",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/gatewaytemplates/:gatewaytemplate_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "gatewaytemplate_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Organization Gateway Template"
},
{
"info": {
"name": "deleteOrgGatewayTemplate",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/gatewaytemplates/:gatewaytemplate_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "gatewaytemplate_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Organization Gateway Template"
}
]
},
{
"info": {
"name": "Orgs Guests",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgGuestAuthorizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Org Guest Authorizations"
},
{
"info": {
"name": "countOrgGuestAuthorizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Org Authorized Guest"
},
{
"info": {
"name": "searchOrgGuestAuthorization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "query",
"description": "WLAN ID"
},
{
"name": "auth_method",
"value": "",
"type": "query",
"description": "Authentication Method"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
}
]
},
"docs": "Search Authorized Guest"
},
{
"info": {
"name": "getOrgGuestAuthorization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests/:guest_mac",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Get Guest Authorization"
},
{
"info": {
"name": "updateOrgGuestAuthorization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests/:guest_mac",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Guest Authorization"
},
{
"info": {
"name": "deleteOrgGuestAuthorization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/guests/:guest_mac",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Guest Authorization"
}
]
},
{
"info": {
"name": "Orgs IDP Profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgIdpProfiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/idpprofiles",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get the list of Org IDP Profiles"
},
{
"info": {
"name": "createOrgIdpProfile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/idpprofiles",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Org IDP Profile"
},
{
"info": {
"name": "getOrgIdpProfile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/idpprofiles/:idpprofile_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "idpprofile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org IDP Profile"
},
{
"info": {
"name": "updateOrgIdpProfile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/idpprofiles/:idpprofile_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "idpprofile_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org IDP Profile"
},
{
"info": {
"name": "deleteOrgIdpProfile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/idpprofiles/:idpprofile_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "idpprofile_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org IDP Profile"
}
]
},
{
"info": {
"name": "Orgs SLEs",
"type": "folder"
},
"items": [
{
"info": {
"name": "getOrgSitesSle",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/insights/sites-sle",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "sle",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Org Sites SLE"
},
{
"info": {
"name": "getOrgSle",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/insights/:metric",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for available metrics"
},
{
"name": "sle",
"value": "",
"type": "query",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for more details"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get Org SLEs (all/worst sites, Mx Edges, ...)"
}
]
},
{
"info": {
"name": "Orgs Inventory",
"type": "folder"
},
"items": [
{
"info": {
"name": "getOrgInventory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "serial",
"value": "",
"type": "query",
"description": "Device serial"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id if assigned, null if not assigned"
},
{
"name": "vc_mac",
"value": "",
"type": "query",
"description": "Virtual Chassis MAC Address"
},
{
"name": "vc",
"value": "",
"type": "query",
"description": "To display Virtual Chassis members"
},
{
"name": "unassigned",
"value": "",
"type": "query",
"description": "To display Unassigned devices"
},
{
"name": "modified_after",
"value": "",
"type": "query",
"description": "Filter on inventory last modified time, in epoch"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Org Inventory\n\n### VC (Virtual-Chassis) Management \n\nStarting with the April release, Virtual Chassis devices in Mist will now use\na cloud-assigned virtual MAC address as the device ID, instead of the physical\nMAC address of the FPC0 member.\n\n\n**Retrieving the device ID or Site ID of a Virtual Chassis:**\n\n1. Use this API call with the query parameters `vc=true` and `mac` set to the MAC address of the VC member.\n\n2. In the response, check the `vc_mac` and `mac` fields:\n\n - If `vc_mac` is e"
},
{
"info": {
"name": "addOrgInventory",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add Device to Org Inventory with the device claim codes"
},
{
"info": {
"name": "updateOrgInventoryAssignment",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org Inventory"
},
{
"info": {
"name": "countOrgInventory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site ID"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Software version"
},
{
"name": "status",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of in the Org Inventory"
},
{
"info": {
"name": "createOrgGatewayHaCluster",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/create_ha_cluster",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create HA Cluster from unassigned Gateways"
},
{
"info": {
"name": "deleteOrgGatewayHaCluster",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/delete_ha_cluster",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete HA Cluster\n\nAfter HA cluster deleted, both of the nodes will be unassigned."
},
{
"info": {
"name": "reevaluateOrgAutoAssignment",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/reevaluate_auto_assignment",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Reevaluate Auto Assignment"
},
{
"info": {
"name": "replaceOrgDevices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/replace",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "It’s a common request we get from the customers. When a AP HW has problem and need a replacement, they would want to copy the existing attributes (Device Config) of this old AP to the new one. It can be done by providing the MAC of a device that’s currently in the inventory but not assigned. The Device replaced will become unassigned.\n\nThis API also supports replacement of Mist Edges. This API copies device agnostic attributes from old Mist edge to new one.\nMist manufactured Mist Edges will be r"
},
{
"info": {
"name": "searchOrgInventory",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/inventory/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address. Partial match allowed with wildcard * (e.g. `*5b35*` will match `5c5b350e0001` and `5c5b35000301`)."
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Device name. Always a partial match (e.g. `london` will match `london-1`, `london-2`, `my-london-device`...)"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id if assigned, null if not assigned"
},
{
"name": "serial",
"value": "",
"type": "query",
"description": "Device serial number. Partial match allowed with wildcard * (e.g. `*123*` will match `AB123CD`, `12345`, `XY123`)"
},
{
"name": "master",
"value": "",
"type": "query",
"description": "true / false"
},
{
"name": "sku",
"value": "",
"type": "query",
"description": "Device SKU. Partial match allowed with wildcard * (e.g. `*2300*` will match `EX2300-F-12P`)"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Device version. Partial match allowed with wildcard * (e.g. `2R3` will match `21.2R3-S3.5`)"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Device status. enum: `connected`, `disconnected`"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Wildcards for name, mac, serial"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search in the Org Inventory"
}
]
},
{
"info": {
"name": "Orgs JSI",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgJsiDevices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/devices",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "serial",
"value": "",
"type": "query",
"description": "Device serial"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device MAC Address"
}
]
},
"docs": "Get List of Org devices that connected to JSI"
},
{
"info": {
"name": "adoptOrgJsiDevice",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/devices/outbound_ssh_cmd",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "Adopt JSI devices"
},
{
"info": {
"name": "createOrgJsiDeviceShellSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/devices/:device_mac/shell",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Create Shell Session"
},
{
"info": {
"name": "listOrgJsiPastPurchases",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/inventory",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query"
},
{
"name": "serial",
"value": "",
"type": "query"
}
]
},
"docs": "This gets all devices purchased from the accounts associated with the Org \n * Fetch Install base devices for all linked accounts and associated account of the linked accounts. \n * The primary and the associated account ids will be queries from SFDC by passing the linked account \n * Returns only the device centric details of the Install base device. No customer specific information will be returned."
},
{
"info": {
"name": "countOrgJsiAssetsAndContracts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/inventory/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "Distinct attributes to count"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count devices purchased from the accounts associated with the Org"
},
{
"info": {
"name": "searchOrgJsiAssetsAndContracts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/inventory/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "claimed",
"value": "",
"type": "query",
"description": "Device claim status, `true` for claimed devices, `false` for all devices"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "serial",
"value": "",
"type": "query",
"description": "Device serial"
},
{
"name": "sku",
"value": "",
"type": "query",
"description": "SKU name of the device"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Device status"
},
{
"name": "warranty_type",
"value": "",
"type": "query",
"description": "Device warranty type"
},
{
"name": "eol_after",
"value": "",
"type": "query",
"description": "Filter devices with End Of Life date after this date"
},
{
"name": "eol_before",
"value": "",
"type": "query",
"description": "Filter devices with End Of Life date before this date"
},
{
"name": "eos_after",
"value": "",
"type": "query",
"description": "Filter devices with End Of Support date after this date"
},
{
"name": "eos_before",
"value": "",
"type": "query",
"description": "Filter devices with End Of Support date before this date"
},
{
"name": "version_eos_after",
"value": "",
"type": "query",
"description": "Filter devices with OS Version End Of Support date after this date"
},
{
"name": "version_eos_before",
"value": "",
"type": "query",
"description": "Filter devices with OS Version End Of Support date before this date"
},
{
"name": "has_support",
"value": "",
"type": "query",
"description": "Indicates if the device is covered under active support contract"
},
{
"name": "sirt_id",
"value": "",
"type": "query",
"description": "To get the onboarded devices that are affected by the SIRT ID"
},
{
"name": "pbn_id",
"value": "",
"type": "query",
"description": "To get the onboarded devices that are affected by the PBN ID"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Wildcards for `serial`, `model`, `account_id`"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "This gets all devices purchased from the accounts associated with the Org \n * Fetch Install base devices for all linked accounts and associated account of the linked accounts. \n * The primary and the associated account ids will be queries from SFDC by passing the linked account \n * Returns only the device centric details of the Install base device. No customer specific information will be returned."
},
{
"info": {
"name": "countOrgJsiPbn",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/pbn/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "Field to group by enum: `versions`, `models`, `customer_risk`, `bug_type`"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get count of PBN advisories grouped by specified field"
},
{
"info": {
"name": "searchOrgJsiPbn",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/pbn/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "versions",
"value": "",
"type": "query",
"description": "OS versions to search for"
},
{
"name": "models",
"value": "",
"type": "query",
"description": "Device models to search for"
},
{
"name": "customer_risk",
"value": "",
"type": "query",
"description": "Customer risk level to filter by"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "PBN ID to search for"
},
{
"name": "bug_type",
"value": "",
"type": "query",
"description": "Bug type to filter by"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Text search for PBN (Problem Bug Notification) advisories. Search can be done on versions, models, customer_risk, id, and bug_type fields."
},
{
"info": {
"name": "countOrgJsiSirt",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/sirt/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "Field to group by. enum: `jsa_updated_date`, `models`, `severity`, `versions`"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get count of SIRT advisories grouped by specified field"
},
{
"info": {
"name": "searchOrgJsiSirt",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/jsi/sirt/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "severity",
"value": "",
"type": "query",
"description": "Severity of the SIRT (Critical, High, Medium, Low)"
},
{
"name": "id",
"value": "",
"type": "query",
"description": "JSA number"
},
{
"name": "updated_after",
"value": "",
"type": "query",
"description": "JSA Updated date to be filtered after this date"
},
{
"name": "updated_before",
"value": "",
"type": "query",
"description": "JSA Updated date to be filtered before this date"
},
{
"name": "published_after",
"value": "",
"type": "query",
"description": "JSA Published date to be filtered after this date"
},
{
"name": "published_before",
"value": "",
"type": "query",
"description": "JSA Published date to be filtered before this date"
},
{
"name": "models",
"value": "",
"type": "query",
"description": "Models affected by the SIRT"
},
{
"name": "versions",
"value": "",
"type": "query",
"description": "Software version affected by the SIRT"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Wildcards search on os_version_affected, affected_models, severity, jsa_id"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Search and get all the SIRT for the onboarded devices. Search can be done on severity, id, updated_after, updated_before, published_after, published_before, models, versions, and text fields."
}
]
},
{
"info": {
"name": "Orgs Logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgAuditLogsLegacy",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/logs",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id"
},
{
"name": "admin_name",
"value": "",
"type": "query",
"description": "Admin name or email"
},
{
"name": "message",
"value": "",
"type": "query",
"description": "Message"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort order"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of change logs for the current Org"
},
{
"info": {
"name": "countOrgAuditLogs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/logs/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "admin_id",
"value": "",
"type": "query"
},
{
"name": "admin_name",
"value": "",
"type": "query"
},
{
"name": "site_id",
"value": "",
"type": "query"
},
{
"name": "message",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Audit Logs"
},
{
"info": {
"name": "listOrgAuditLogs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/logs/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id"
},
{
"name": "admin_name",
"value": "",
"type": "query",
"description": "Admin name or email"
},
{
"name": "message",
"value": "",
"type": "query",
"description": "Message"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort order"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get a list of change logs for the current Org"
}
]
},
{
"info": {
"name": "Orgs Maps",
"type": "folder"
},
"items": [
{
"info": {
"name": "importOrgMaps",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/maps/import",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches\n\n### CSV File Format\n```csv\nVendor AP name,Mist AP Mac\nUS Office AP-2 - 5c:5b:35:00:00:02,5c5b35000002\n```"
},
{
"info": {
"name": "importOrgMapToSite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/sites/:site_name/maps/import",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "site_name",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Import data from files is a multipart POST which has a file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches\n\n#### Request\n\n```\n\"json\": a JSON string describing your upload\n\"file\": a binary file\n```"
}
]
},
{
"info": {
"name": "Orgs Marvis Invites",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgMarvisClientInvites",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/marvisinvites",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
]
},
"docs": "List Org Marvis Client Invites"
},
{
"info": {
"name": "createOrgMarvisClientInvite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/marvisinvites",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Org Marvis Client Invite. SDK Invites can be generated for (and belongs to) an Org. They can be generated by an Admin of an Org and can be revoked at anytime."
},
{
"info": {
"name": "getOrgMarvisClientInvite",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/marvisinvites/:marvisinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "marvisinvite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org Marvis Client Invite"
},
{
"info": {
"name": "updateOrgMarvisClientInvite",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/marvisinvites/:marvisinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "marvisinvite_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org Marvis Client Invite"
},
{
"info": {
"name": "deleteOrgMarvisClientInvite",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/marvisinvites/:marvisinvite_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "marvisinvite_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org Marvis Client Invite"
}
]
},
{
"info": {
"name": "Orgs NAC IDP",
"type": "folder"
},
"items": [
{
"info": {
"name": "validateOrgIdpCredential",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mist_nac/test_idp",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "IDP Credential Validation. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n``` json\n{\n \"subscribe\": \"orgs/{org_id}/mist_nac/test_idp\"\n}\n\n ```\n\n### Response (no idp can be found)\n\n``` json\n{\n \"event\": \"data\",\n \"channel\": \"/orgs/{org_id}/mist_nac/test"
}
]
},
{
"info": {
"name": "Orgs MxClusters",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgMxEdgeClusters",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxclusters",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Org MxEdge Clusters"
},
{
"info": {
"name": "createOrgMxEdgeCluster",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxclusters",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MxCluster"
},
{
"info": {
"name": "getOrgMxEdgeCluster",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxclusters/:mxcluster_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxcluster_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org MxEdge Cluster Details"
},
{
"info": {
"name": "updateOrgMxEdgeCluster",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxclusters/:mxcluster_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxcluster_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org MxEdge Cluster"
},
{
"info": {
"name": "deleteOrgMxEdgeCluster",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxclusters/:mxcluster_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxcluster_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org MXEdge Cluster"
}
]
},
{
"info": {
"name": "Orgs MxEdges",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgMxEdges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "for_site",
"value": "",
"type": "query",
"description": "Filter for org/site level mist edges"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Org MxEdges"
},
{
"info": {
"name": "createOrgMxEdge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MxEdge"
},
{
"info": {
"name": "assignOrgMxEdgeToSite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/assign",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign Org MxEdge to Site"
},
{
"info": {
"name": "claimOrgMxEdge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/claim",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "For a Mist Edge in default state, it will show a random claim code like `135-546-673` which you can \"claim\" it into your Org"
},
{
"info": {
"name": "countOrgMxEdges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Mist edge site id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Model name"
},
{
"name": "distro",
"value": "",
"type": "query",
"description": "Debian code name (buster, bullseye)"
},
{
"name": "tunterm_version",
"value": "",
"type": "query",
"description": "tunterm version"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort options, -prefix represents DESC order, default is -last_seen"
},
{
"name": "stats",
"value": "",
"type": "query",
"description": "Whether to return device stats, default is false"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Org Mist Edges"
},
{
"info": {
"name": "countOrgSiteMxEdgeEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/events/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "service",
"value": "",
"type": "query",
"description": "Service running on mist edge(mxagent, tunterm etc)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Org Mist Edge Events"
},
{
"info": {
"name": "searchOrgMistEdgeEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/events/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "service",
"value": "",
"type": "query",
"description": "Service running on mist edge(mxagent, tunterm etc)"
},
{
"name": "component",
"value": "",
"type": "query",
"description": "Component like PS1, PS2"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org Mist Edge Events"
},
{
"info": {
"name": "searchOrgMxEdges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported"
},
{
"name": "distro",
"value": "",
"type": "query",
"description": "Debian code name (buster, bullseye)"
},
{
"name": "tunterm_version",
"value": "",
"type": "query",
"description": "tunterm version"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Mist edge site id"
},
{
"name": "stats",
"value": "",
"type": "query",
"description": "Whether to return device stats, default is false"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org Mist Edges"
},
{
"info": {
"name": "unassignOrgMxEdgeFromSite",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/unassign",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unassign Org MxEdge from Site"
},
{
"info": {
"name": "getOrgMxEdgeUpgradeInfo",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/versions",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "Upgrade channel to follow, stable (default) / beta / alpha"
},
{
"name": "distro",
"value": "",
"type": "query",
"description": "Distro code name (e.g. `buster`, `bullseye`, ...)"
}
]
},
"docs": "Get Mist Edge Upgrade Information"
},
{
"info": {
"name": "getOrgMxEdge",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org MxEdge details"
},
{
"info": {
"name": "updateOrgMxEdge",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org MxEdge"
},
{
"info": {
"name": "deleteOrgMxEdge",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org MxEdge"
},
{
"info": {
"name": "addOrgMxEdgeImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/image/:image_number",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
},
{
"name": "image_number",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Attach up to 3 images to a mxedge"
},
{
"info": {
"name": "deleteOrgMxEdgeImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/image/:image_number",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
},
{
"name": "image_number",
"value": "",
"type": "path"
}
]
},
"docs": "Remove MxEdge Image"
},
{
"info": {
"name": "restartOrgMxEdge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/restart",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register."
},
{
"info": {
"name": "bounceOrgMxEdgeDataPorts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/tunterm/bounce_port",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Bounce TunTerm Data Ports"
},
{
"info": {
"name": "disconnectOrgMxEdgeTuntermAps",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/tunterm/disconnect_aps",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Disconnect AP’s from TunTerm"
},
{
"info": {
"name": "controlOrgMxEdgeServices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/:name/:action",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
},
{
"name": "name",
"value": "",
"type": "path",
"description": "enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`"
},
{
"name": "action",
"value": "",
"type": "path",
"description": "Restart or start or stop"
}
]
},
"docs": "Control Services on a Mist Edge"
},
{
"info": {
"name": "uploadOrgMxEdgeSupportFiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/support",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Support / Upload Mist Edge support files"
},
{
"info": {
"name": "unregisterOrgMxEdge",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/unregister",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "In the case where a Mist Edge is replaced, you would need to unregister it. Which disconnects the currently the connected Mist Edge and allow another to register."
},
{
"info": {
"name": "getOrgMxEdgeVmParams",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/vm_params",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Mist Edge VM parameters"
}
]
},
{
"info": {
"name": "Orgs MxTunnels",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgMxTunnels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxtunnels",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Org MxTunnels"
},
{
"info": {
"name": "createOrgMxTunnel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxtunnels",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create MxTunnel"
},
{
"info": {
"name": "getOrgMxTunnel",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxtunnels/:mxtunnel_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxtunnel_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org MxTunnel Details"
},
{
"info": {
"name": "updateOrgMxTunnel",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxtunnels/:mxtunnel_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxtunnel_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org MxTunnel"
},
{
"info": {
"name": "deleteOrgMxTunnel",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/mxtunnels/:mxtunnel_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "mxtunnel_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org MxTunnel"
}
]
},
{
"info": {
"name": "Orgs Clients - NAC",
"type": "folder"
},
"items": [
{
"info": {
"name": "countOrgNacClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nac_clients/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "last_nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "last_vlan_id",
"value": "",
"type": "query",
"description": "Vlan ID"
},
{
"name": "last_nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "last_ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "last_username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id if assigned, null if not assigned"
},
{
"name": "last_ap",
"value": "",
"type": "query",
"description": "AP MAC connected to by client"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "last_status",
"value": "",
"type": "query",
"description": "Connection status of client i.e \"permitted\", \"denied, \"session_ended\""
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Client type i.e. \"wireless\", \"wired\" etc."
},
{
"name": "mdm_compliance_status",
"value": "",
"type": "query",
"description": "MDM compliance of client i.e \"compliant\", \"not compliant\""
},
{
"name": "mdm_provider",
"value": "",
"type": "query",
"description": "MDM provider of client’s organization eg \"intune\", \"jamf\""
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of NAC Clients"
},
{
"info": {
"name": "countOrgNacClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nac_clients/events/count",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of NAC Client-Events"
},
{
"info": {
"name": "searchOrgNacClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nac_clients/events/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "dryrun_nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Dry Run Rule ID, if present and matched"
},
{
"name": "dryrun_nacrule_matched",
"value": "",
"type": "query",
"description": "True - if dryrun rule present and matched with priority, False - if not matched or not present"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "Vlan name or ID assigned to the client"
},
{
"name": "nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "bssid",
"value": "",
"type": "query",
"description": "BSSID"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "idp_role",
"value": "",
"type": "query",
"description": "IDP returned roles/groups for the user"
},
{
"name": "idp_username",
"value": "",
"type": "query",
"description": "Username presented to the Identity Provider"
},
{
"name": "resp_attrs",
"value": "",
"type": "query",
"description": "Radius attributes returned by NAC to NAS derive"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id"
},
{
"name": "ap",
"value": "",
"type": "query",
"description": "AP MAC"
},
{
"name": "random_mac",
"value": "",
"type": "query",
"description": "AP random macMAC"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "usermac_label",
"value": "",
"type": "query",
"description": "Labels derived from usermac entry"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Partial / full MAC address, username, device_mac or ap"
},
{
"name": "nas_ip",
"value": "",
"type": "query",
"description": "IP address of NAS device"
},
{
"name": "ingress_vlan",
"value": "",
"type": "query",
"description": "Vendor specific Vlan ID in radius requests"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order."
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search NAC Client Events"
},
{
"info": {
"name": "searchOrgNacClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nac_clients/search",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "ap",
"value": "",
"type": "query",
"description": "MAC Address of the AP the client is/was connected to"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "cert_expiry_duration",
"value": "",
"type": "query",
"description": "Filter by certificate expiry within a specific duration from now (e.g., \"7d\" for 7 days, \"1m\" for 1 month)"
},
{
"name": "edr_managed",
"value": "",
"type": "query",
"description": "Filters NAC clients that are integrated with EDR providers"
},
{
"name": "edr_provider",
"value": "",
"type": "query",
"description": "EDR provider of client's organization"
},
{
"name": "edr_status",
"value": "",
"type": "query",
"description": "EDR Status of the NAC client"
},
{
"name": "family",
"value": "",
"type": "query",
"description": "Partial / full Client family (e.g. \"Phone/Tablet/Wearable\", \"Access Point\"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Surveillance*` and `*urveillance*` match `Surveillance Camera`). Suffix-only wildcards (e.g. `*Camera`) are not supported"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Partial / full Client MAC Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported"
},
{
"name": "mdm_compliance",
"value": "",
"type": "query",
"description": "MDM compliance of client i.e \"compliant\", \"not compliant\""
},
{
"name": "mdm_provider",
"value": "",
"type": "query",
"description": "MDM provider of client’s organization eg \"intune\", \"jamf\""
},
{
"name": "mdm_managed",
"value": "",
"type": "query",
"description": "Filters NAC clients that are managed by MDM providers"
},
{
"name": "mfg",
"value": "",
"type": "query",
"description": "Partial / full Client manufacturer (e.g. \"apple\", \"cisco\", \"juniper\"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Raspberry Pi*` and `*Pi*` match `Raspberry Pi Trading Ltd`). Suffix-only wildcards (e.g. `*Ltd`) are not supported"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Client model, e.g. \"iPhone 12\", \"MX100\""
},
{
"name": "nacrule_name",
"value": "",
"type": "query",
"description": "NAC Policy Rule Name matched"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "nas_ip",
"value": "",
"type": "query",
"description": "IP address of NAS device"
},
{
"name": "ingress_vlan",
"value": "",
"type": "query",
"description": "Vendor specific Vlan ID in radius requests"
},
{
"name": "os",
"value": "",
"type": "query",
"description": "Client OS, e.g. \"iOS 18.1\", \"Android\", \"Windows\", \"Linux\""
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Connection status of client i.e \"permitted\", \"denied, \"session_started\", \"session_stopped\""
},
{
"name": "text",
"value": "",
"type": "query",
"description": "partial / full MAC address, last_username, device_mac, nas_ip or last_ap"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Client type i.e. \"wireless\", \"wired\" etc."
},
{
"name": "usermac_label",
"value": "",
"type": "query",
"description": "Labels derived from usermac entry"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "Vlan name or ID assigned to the client"
},
{
"name": "site_id",
"value": "",
"type": "query",
"description": "Site id if assigned, null if not assigned"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order."
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Org NAC Clients"
},
{
"info": {
"name": "sendOrgNacClientCoA",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nac_clients/:client_mac/coa",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "client_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sends CoA (Change of Authorization) command to a NAC client."
}
]
},
{
"info": {
"name": "Orgs NAC Portals",
"type": "folder"
},
"items": [
{
"info": {
"name": "listOrgNacPortals",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "List Org NAC Portals"
},
{
"info": {
"name": "createOrgNacPortal",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Org NAC Portal"
},
{
"info": {
"name": "getOrgNacPortal",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org NAC Portal"
},
{
"info": {
"name": "updateOrgNacPortal",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org NAC Portal"
},
{
"info": {
"name": "deleteOrgNacPortal",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Org NAC Portal"
},
{
"info": {
"name": "listOrgNacPortalSsoLatestFailures",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/failures",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Org NAC Portal SSO Latest Failures"
},
{
"info": {
"name": "uploadOrgNacPortalImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/portal_image",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Upload background image for NAC Portal"
},
{
"info": {
"name": "deleteOrgNacPortalImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/portal_image",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete background image for NAC Portal\n\n\nIf image is not uploaded or is deleted, NAC Portal will use default image."
},
{
"info": {
"name": "updateOrgNacPortalTemplate",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/portal_template",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Org NAC Portal Template"
},
{
"info": {
"name": "getOrgNacPortalSamlMetadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/saml_metadata",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Org NAC Portal SAML Metadata"
},
{
"info": {
"name": "downloadOrgNacPortalSamlMetadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/orgs/:org_id/nacportals/:nacportal_id/saml_metadata.xml",
"params": [
{
"name": "org_id",
"value": "",
"type": "path"
},
{
"name": "nacportal_id",
"value": "",
"type": "path"
}
]
},
"docs": "Download Org NAC Portal SAML Metadata\n\nExample of metadata.xml:\n```xml\n\n \n \n \n (string): IP address of the RADIUS server as the key\n * `auth_accepts` (long): Number of accepted authentication requests\n * `auth_rejects` (long): Number of rejected authentication requests\n * `auth_timeouts` (long): Number of authentication timeouts\n * `auth_server_status` (string): Status of the server. Possible values: `up`, `down`, `unreachable`"
},
{
"name": "stats",
"value": "",
"type": "query",
"description": "Whether to return device stats"
},
{
"name": "t128agent_version",
"value": "",
"type": "query",
"description": "When `type`==`gateway` (SSR only), version of 128T agent"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of device. enum: `ap`, `gateway`, `switch`"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Version"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort options"
},
{
"name": "desc_sort",
"value": "",
"type": "query",
"description": "Sort options in reverse order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Device"
},
{
"info": {
"name": "getSiteDevice",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Device Configuration"
},
{
"info": {
"name": "updateSiteDevice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Device Configuration"
},
{
"info": {
"name": "addSiteDeviceImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/image/:image_number",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "image_number",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Attach up to 3 images to a device"
},
{
"info": {
"name": "deleteSiteDeviceImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/image/:image_number",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "image_number",
"value": "",
"type": "path"
}
]
},
"docs": "Delete image from a device"
}
]
},
{
"info": {
"name": "Sites Devices - Wireless",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteDeviceRadioChannels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/ap_channels",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "country_code",
"value": "US",
"type": "query",
"description": "Country code for the site (for AP config generation), in [two-character](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)"
}
]
},
"docs": "Get a list of allowed channels (per channel width)"
},
{
"info": {
"name": "getSiteDeviceIotPort",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/iot",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Returns the current state of each enabled IoT pin configured as an output."
},
{
"info": {
"name": "setSiteDeviceIotPort",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/iot",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "**Note**: For each IoT pin referenced:\n * The pin must be enabled using the Device `iot_config` API\n * The pin must support the output direction"
},
{
"info": {
"name": "enableSiteDeviceZigbeeJoin",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/zigbee_join",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Allow Zigbee end devices to join the network for a configurable duration. After the duration expires, new joins will be blocked (unless `allow_join`==`always` is configured on the device).\n\n#### Subscribe to Zigbee Join Events\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/zigbee_join\"\n}\n```\n##### Example output from ws stream\n```json\n{\n \"event\": \"data\",\n \"channel\": \"/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b35"
}
]
},
{
"info": {
"name": "Utilities Common",
"type": "folder"
},
"items": [
{
"info": {
"name": "restartSiteMultipleDevices",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/restart",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Note that only the devices that are connected will be restarted."
},
{
"info": {
"name": "arpFromDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/arp",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "ARP can be performed on the Device. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{ \n \"event\": \"data\", \n \"channel\": \"/sites/4ac1dcf4-9d8b-721"
},
{
"info": {
"name": "bounceDevicePort",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/bounce_port",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Port Bounce can be performed from Switch/Gateway.\n\n **Note:** Ports starting with vme, ae, irb, and HA control ports (for SSR only) are not supported\n\nThe output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/"
},
{
"info": {
"name": "clearSiteDeviceMacTable",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_mac_table",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear MAC Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n"
},
{
"info": {
"name": "clearSiteDevicePolicyHitCount",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_policy_hit_count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear application policy hit counts for the specified policy."
},
{
"info": {
"name": "getSiteDeviceConfigCmd",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/config_cmd",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Make output cmds sorted (for better readability) or not."
}
]
},
"docs": "Get Config CLI Commands\nFor a brown-field switch deployment where we adopted the switch through Adoption Command, we do not wipe out / overwrite the existing config automatically. Instead, we generate CLI commands that we would have generated. The user can inspect, modify, and incorporate this into their existing config manually.\n\nOnce they feel comfortable about the config we generate, they can enable allow_mist_config where we will take full control of their config like a claimed switch"
},
{
"info": {
"name": "startSiteLocateDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/locate",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "### Access Points\nLocate an Access Point by blinking it's LED.\nIt is a persisted state that has to be stopped by calling Stop Locating API\n\n### Switches\nLocate a Switch by blinking all port LEDs. \nBy default, request is sent to `master` switch and LEDs will keep flashing for 5 minutes.\nIn case of virtual chassis (VC) the desired member mac has to be passed in the request payload. \nAt anypoint, only one VC member can be requested to flash the LED. \nTo stop LED flashing before the duration ends /u"
},
{
"info": {
"name": "monitorSiteDeviceTraffic",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/monitor_traffic",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Monitor traffic on switches and SRX.\n * JUNOS uses cmd \"monitor interface \" to monitor traffic on particular \n * JUNOS uses cmd \"monitor interface traffic\" to monitor traffic on all ports"
},
{
"info": {
"name": "pingFromDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/ping",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Ping from AP, Switch and SSR\n\nPing can be performed from the Device. The output will be available through websocket. As there can be multiple commands issued against the same AP at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n \"event\": \"data\",\n "
},
{
"info": {
"name": "readoptSiteOctermDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/readopt",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "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 correct device ID to connect the cloud."
},
{
"info": {
"name": "releaseSiteDeviceDhcpLease",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/release_dhcp_leases",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Releases an active DHCP lease."
},
{
"info": {
"name": "readoptSiteOctermDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/reprovision",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "To force one device to reprovision itself again."
},
{
"info": {
"name": "getSiteDeviceZtpPassword",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/request_ztp_password",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "In the case where something 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."
},
{
"info": {
"name": "restartSiteDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/restart",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Restart / Reboot a device"
},
{
"info": {
"name": "createSiteDeviceShellSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/shell",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Shell Session"
},
{
"info": {
"name": "showSiteDeviceBgpSummary",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_bgp_summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get BGP Summary from SSR, SRX and Switch.\n\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n\n}\n```\n\n##### Example output from ws stream\n```\nTue 2024-04-23 16:36:06 UTC\nRetrieving bgp entri"
},
{
"info": {
"name": "showSiteDeviceDhcpLeases",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_dhcp_leases",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Shows DHCP leases"
},
{
"info": {
"name": "showSiteDeviceDot1xTable",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_dot1x",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get Dot1X Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n"
},
{
"info": {
"name": "showSiteDeviceEvpnDatabase",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_evpn_database",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get EVPN Database from the Device. The output will be available through websocket."
},
{
"info": {
"name": "showSiteDeviceForwardingTable",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_forwarding_table",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get forwarding table from the Device. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n##### Example output from ws stream\n```\nMon 2024-05-20 16:47:30 UTC Retrieving fib entries… Ent"
},
{
"info": {
"name": "showSiteDeviceMacTable",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_mac_table",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get MAC Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n```\n\n\n#### Example output from ws stream\n\n```json \n{\n \"event\": \"data\",\n \"channel\": \"/sites/d6fb4f96"
},
{
"info": {
"name": "uploadSiteDeviceSupportFile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/support",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Support / Upload device support files\n\n#### Info Param\n| Name | Type | Description |\n| --- | --- | --- |\n| process | string | Upload 1 file with output of show system processes extensive |\n| outbound-ssh | string | Upload 1 file that concatenates all /var/log/outbound-ssh.log* files |\n| messages | string | Upload 1 to 10 /var/log/messages* files |\n| core-dumps | string | Upload all core dump files, if any. Uploads for all members of VC on switches.|\n| full | string | Upload 1 file with output of"
},
{
"info": {
"name": "tracerouteFromDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/traceroute",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Traceroute can be performed from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same Device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n\n#### Example output from ws stream\n```json\n{\n \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-x"
},
{
"info": {
"name": "stopSiteLocateDevice",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/unlocate",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Stop Locate a Device"
}
]
},
{
"info": {
"name": "Utilities Location",
"type": "folder"
},
"items": [
{
"info": {
"name": "sendSiteDevicesArbitraryBleBeacon",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/send_ble_beacon",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Send arbitrary BLE Beacon for a period of time\n\nNote that only the devices that are connected will be restarted."
}
]
},
{
"info": {
"name": "Sites Synthetic Tests",
"type": "folder"
},
"items": [
{
"info": {
"name": "triggerSiteSwitchRadiusSyntheticTest",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/check_radius_server",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Ping test from the AP to confirm 'reachability' of the Radius server. \n\nUtilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the Radius Server 'availability'.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n\n```json\n{\n \"event\": \"data\",\n \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0"
},
{
"info": {
"name": "getSiteDeviceSyntheticTest",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/synthetic_test",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Device Synthetic Test"
},
{
"info": {
"name": "triggerSiteDeviceSyntheticTest",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/synthetic_test",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Trigger Device Synthetic Test"
},
{
"info": {
"name": "triggerSiteSyntheticTest",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/synthetic_test",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Trigger Synthetic Testing"
},
{
"info": {
"name": "searchSiteSyntheticTest",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/synthetic_test/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device MAC Address"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port_id used to run the test (for SSR only)"
},
{
"name": "vlan_id",
"value": "",
"type": "query",
"description": "VLAN ID"
},
{
"name": "by",
"value": "",
"type": "query",
"description": "Entity who triggers the test"
},
{
"name": "reason",
"value": "",
"type": "query",
"description": "Test failure reason"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Synthetic test type"
},
{
"name": "protocol",
"value": "",
"type": "query",
"description": "Connectivity protocol"
},
{
"name": "tenant",
"value": "",
"type": "query",
"description": "Tenant network in which lan_connectivity test was run"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site Synthetic Testing"
}
]
},
{
"info": {
"name": "Utilities WAN",
"type": "folder"
},
"items": [
{
"info": {
"name": "clearSiteSsrArpCache",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_arp",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear ARP cache for SSR, SRX and Switch\n\nClear the entire ARP cache or a subset if arguments are provided.\n\n*Note*: port_id is optional if neither vlan nor ip is specified"
},
{
"info": {
"name": "clearSiteBgpRoutes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_bgp",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear routes associated with one or all BGP neighbors"
},
{
"info": {
"name": "clearSiteDeviceSession",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_session",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Clear session"
},
{
"info": {
"name": "releaseSiteSsrDhcpLease",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/release_dhcp",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Releases an active DHCP lease.\n\n\nThe output will be available through websocket.\n\nAs there can be multiple commands issued against the same Device at the same\ntime and the output all goes through the same websocket stream, session is\nintroduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n\n`WS /api-ws/v1/stream`\n\n\n```json\n\n{ \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" }\n\n```\n\n\n\n#### Example output from ws stream\n\n\n```json\n{\n \"event\": \"data\",\n \"channel\": \"/sites/d6fb4"
},
{
"info": {
"name": "testSiteSsrDnsResolution",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/resolve_dns",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "DNS resolutions are performed on the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same SSR at the same time and the output all goes through the same websocket stream, `session` is used for demux.\n \n #### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\n Router | Hostname | Resolved | Last"
},
{
"info": {
"name": "runSiteSrxTopCommand",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/run_top",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Run top command on switches and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```"
},
{
"info": {
"name": "servicePingFromSsr",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/service_ping",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Ping from SSR\n\nService Ping can be performed from the Device. The output will be available through websocket. As there can be multiple command issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n \"event\": \"data\",\n \"cha"
},
{
"info": {
"name": "showSiteGatewayOspfDatabase",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_ospf_database",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get OSPF Database from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== ==="
},
{
"info": {
"name": "showSiteGatewayOspfInterfaces",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_ospf_interfaces",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get OSPF interfaces from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ================== =================== ==========="
},
{
"info": {
"name": "showSiteGatewayOspfNeighbors",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_ospf_neighbors",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get OSPF Neighbors from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== ==================== ========== ======= ======== =="
},
{
"info": {
"name": "showSiteGatewayOspfSummary",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_ospf_summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get OSPF summary from SSR and SRX. The output will be available through websocket. \n\nAs there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n```\n===== =========== ========== ============= ================"
},
{
"info": {
"name": "showSiteSsrAndSrxRoutes",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_route",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get routes from SSR, SRX and Switch. \n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```\nadmin@labsystem1.fiedler# show bgp neighbors\nBGP neighb"
},
{
"info": {
"name": "showSiteSsrServicePath",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_service_path",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get service path information of the Device.\n\n\nThe output will be available through websocket. As there can be multiple command\nissued against the same device at the same time and the output all goes through\nthe same websocket stream, session is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json\n{ \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" }\n```\n\n#### Example output from ws stream\n\n```json\n{\n \"channel\": \"/sites/d6fb4f96-xxxx-xxxx-"
},
{
"info": {
"name": "showSiteSsrAndSrxSessions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_session",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get active sessions passing through the Device.\n\n\nThe output will be available through websocket. As there can be multiple command\nissued against the same device at the same time and the output all goes through\nthe same websocket stream, session is introduced for demux.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json \n{ \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\" }\n```\n\n\n#### Example output from ws stream\n\n```json \n{\n \"channel\": \"/sites/d6fb4f96-xxx"
}
]
},
{
"info": {
"name": "Sites Devices - WAN Cluster",
"type": "folder"
},
"items": [
{
"info": {
"name": "GetSiteDeviceHaClusterNode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/ha",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete HA Cluster"
},
{
"info": {
"name": "createSiteDeviceHaCluster",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/ha",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "## Create HA Cluster\nBoth nodes has to be in the same site. We expect the user to configure ha_sync / ha_data port in port_configs already\n\n### SRX cabling\n\nsee [Chassis Cluster User Guide for SRX Series Devices](https://www.juniper.net/documentation/us/en/software/junos/chassis-cluster-security-devices/topics/concept/chassis-cluster-srx-series-node-interface-understanding.html) Here’s the recommended cabling.\n\n#### SRX300\n\nFrom ZTP / default state, ge-0/0/0 and ge-0/0/7 (SFP) are default WAN po"
},
{
"info": {
"name": "deleteSiteDeviceHaCluster",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/ha",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete HA Cluster"
}
]
},
{
"info": {
"name": "Sites Devices - Wired",
"type": "folder"
},
"items": [
{
"info": {
"name": "updateSiteLocalSwitchPortConfig",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/local_port_config",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "API Calls to add port config local overrides. This can be used by Switch Port Operators or Helpdesk administrators\nto change a Switch Port configuration without having to change the switch configuration.\n\n\nThe local overrides configured for the switchports with `no_local_overwrite`==`true` won't be applied to the switch configuration. \n\n\n> NOTE:\n>\n> When using the API Call, it is required to put send all overrides in the PUT request Payload, even the existing once. \n>\n> The current overrides can"
},
{
"info": {
"name": "deleteSiteLocalSwitchPortConfig",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/local_port_config",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "API Calls delete all the existing port config local overrides, and reapply the configured planed at the device level \n(with site / template heritance)."
}
]
},
{
"info": {
"name": "Sites Devices - Wired - Virtual Chassis",
"type": "folder"
},
"items": [
{
"info": {
"name": "changeSiteSwitchVcPortMode",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/set_vc_port_mode",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Change VCP port mode\n\n\nSome switch model allows changing VCP port behaviors, e.g. - use them as regular network ports - change vcp protocol Note, this command will reboot the switch"
},
{
"info": {
"name": "getSiteDeviceVirtualChassis",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get VC Status\n\nThe API returns a combined view of the VC status which includes topology and stats_"
},
{
"info": {
"name": "createSiteVirtualChassis",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory. \nIn case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn't have dedicated VC ports, below are procedures to automate the VC creation:\n1. Power on the switch that is chosen as the VC master first, and then powering on the other membe"
},
{
"info": {
"name": "updateSiteVirtualChassisMember",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The VC creation and adding member switch API will update the device' s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration.\n\n**Note:** Update Device's VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.\n\n\n## Change to use preprovisioned VC\nTo switch the VC to use preprovisioned VC"
},
{
"info": {
"name": "deleteSiteVirtualChassis",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "When all the member switches of VC are removed and only member ID 0 is left, the cloud would detect this situation and automatically changes the single switch to non-VC role.\n\nFor some unexpected cases that the VC is gone and disconnected, the API below could be used to change the state of VC’s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory."
},
{
"info": {
"name": "convertSiteVirtualChassisToVirtualMac",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc/convert_to_virtualmac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Converts an FPC0-based VC to a Virtualmac VC, removing the limitation where the device ID must change whenever FPC0 is renumbered or removed.\n\n\nHTTP400 Error possible reasons:\n - The device is not an OC device\n - Virtualmac VC is disabled in the Org Knob settings\n - The VC is already a Virtualmac VC\n - The VC is currently disconnected\n - The device is standalone\n - A new FPC0 exists with its own device config, causing ambiguity."
},
{
"info": {
"name": "setSiteVcPort",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc/vc_port",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set VC port"
}
]
},
{
"info": {
"name": "Sites Events",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteRoamingEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/events/fast_roam",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "List Roaming Events data"
},
{
"info": {
"name": "countSiteSystemEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/events/system/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of System Events"
},
{
"info": {
"name": "searchSiteSystemEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/events/system/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site System Events"
}
]
},
{
"info": {
"name": "Sites EVPN Topologies",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteEvpnTopologies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/evpn_topologies",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get the existing EVPN topology"
},
{
"info": {
"name": "createSiteEvpnTopology",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/evpn_topologies",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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.\n\n**Notes:**\n1. You can use `core` / `distribution` / `access` to create a CLOS topology\n2. You can also use `core` / `distribution` to form a 2-tier EVPN topology where ESI-Lag is configured distribution to connect to access switc"
},
{
"info": {
"name": "getSiteEvpnTopology",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get One EVPN Topology Detail"
},
{
"info": {
"name": "updateSiteEvpnTopology",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the EVPN Topology"
},
{
"info": {
"name": "deleteSiteEvpnTopology",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/evpn_topologies/:evpn_topology_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "evpn_topology_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete the site EVPN Topology"
}
]
},
{
"info": {
"name": "Sites Gateway Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteGatewayTemplatesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/gatewaytemplates/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Gateway Templates a Site"
}
]
},
{
"info": {
"name": "Sites Guests",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteAllGuestAuthorizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "query",
"description": "UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)"
}
]
},
"docs": "Get List of Site Guest Authorizations"
},
{
"info": {
"name": "countSiteGuestAuthorizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "auth_method",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Authorized Guest"
},
{
"info": {
"name": "listSiteAllGuestAuthorizationsDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "query",
"description": "UUID of single or multiple (Comma separated) WLAN under Site `site_id` (to filter by WLAN)"
},
{
"name": "cross_site",
"value": "",
"type": "query",
"description": "Whether to get org level guests, default is false i.e get site level guests"
}
]
},
"docs": "Get the list of derived Guest Authorizations for a site"
},
{
"info": {
"name": "searchSiteGuestAuthorization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "00000000-0000-0000-0000-000000000000",
"type": "query"
},
{
"name": "auth_method",
"value": "",
"type": "query"
},
{
"name": "ssid",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Authorized Guest"
},
{
"info": {
"name": "getSiteGuestAuthorization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/:guest_mac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Get Guest Authorization"
},
{
"info": {
"name": "updateSiteGuestAuthorization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/:guest_mac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Guest Authorization"
},
{
"info": {
"name": "deleteSiteGuestAuthorization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/guests/:guest_mac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "guest_mac",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Guest Authorization"
}
]
},
{
"info": {
"name": "Sites IDP Profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteIdpProfilesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/idpprofiles/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get the list of derived IDP Profiles for a site"
}
]
},
{
"info": {
"name": "Sites Insights",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteInsightMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "metrics",
"value": "",
"type": "query",
"description": "Comma separated Metric names, e.g. `num_clients,num_aps`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Site Insight Metrics"
},
{
"info": {
"name": "getSiteInsightMetricsForAP",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/ap/:device_id/stats",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "metrics",
"value": "",
"type": "query",
"description": "Comma separated Metric names, e.g. `num_clients,num_stressed_clients`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get AP Insight Metrics"
},
{
"info": {
"name": "getSiteInsightMetricsForClient",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/client/:client_mac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "client_mac",
"value": "",
"type": "path"
},
{
"name": "metrics",
"value": "",
"type": "query",
"description": "Comma separated Metric names, e.g. `top-app-by-num_client,top-app-by-bytes`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Client Insight Metrics"
},
{
"info": {
"name": "getSiteInsightMetricsForDevice",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/device/:device_mac/:metric",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for available metrics"
},
{
"name": "device_mac",
"value": "",
"type": "path"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID of the device, e.g. `ge-0/0/1`. Can be used with metrics related to interfaces, e.g. `rx_bytes`."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get AP Insight Metrics\nSee metrics possibilities at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"info": {
"name": "getSiteInsightMetricsForGateway",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/gateway/:device_id/stats",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "metrics",
"value": "",
"type": "query",
"description": "Comma separated Metric names, e.g. `tx_bps,rx_bps`. See possible values at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID of the gateway device, e.g. `ge-0/0/1`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Gateway Insight Metrics"
},
{
"info": {
"name": "getSiteInsightMetricsForMxEdge",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/mxedge/:device_mac/:metric",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for available metrics"
},
{
"name": "device_mac",
"value": "",
"type": "path"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID of the MxEdge device, e.g. `port0`. Can be used with metrics related to interfaces, e.g. `rx_bytes`."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get MxEdge Insight Metrics\nSee metrics possibilities at [List Insight Metrics](/#operations/listInsightMetrics)"
},
{
"info": {
"name": "getSiteInsightMetricsForSwitch",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/switch/:device_mac/:metric",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "See [List Insight Metrics](/#operations/listInsightMetrics) for available metrics"
},
{
"name": "device_mac",
"value": "",
"type": "path"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID of the switch device, e.g. `ge-0/0/1`. Can be used with metrics related to interfaces, e.g. `rx_bytes`."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Switch Insight Metrics\nSee metrics possibilities at [List Insight Metrics](/#operations/listInsightMetrics)"
}
]
},
{
"info": {
"name": "Sites NAC Fingerprints",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteClientFingerprints",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/fingerprints/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count Client Fingerprints"
},
{
"info": {
"name": "searchSiteClientFingerprints",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/fingerprints/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "family",
"value": "EX Series Switch",
"type": "query",
"description": "Device Category of the client device"
},
{
"name": "client_type",
"value": "wired",
"type": "query",
"description": "Whether client is wired or wireless"
},
{
"name": "model",
"value": "ex4100-f-12p",
"type": "query",
"description": "Model name of the client device"
},
{
"name": "mfg",
"value": "Juniper Networks, Inc.",
"type": "query",
"description": "Manufacturer name of the client device"
},
{
"name": "os",
"value": "JUNOS 22.3R1.12",
"type": "query",
"description": "Operating System name and version of the client device"
},
{
"name": "os_type",
"value": "JUNOS",
"type": "query",
"description": "Operating system name of the client device"
},
{
"name": "mac",
"value": "d420b080516d",
"type": "query",
"description": "MAC address of the client device"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order."
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Client Fingerprints"
}
]
},
{
"info": {
"name": "Sites Rogues",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteRogueAPs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/rogues",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
}
]
},
"docs": "Get List of Site Rogue/Neighbor APs"
},
{
"info": {
"name": "listSiteRogueClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/insights/rogues/clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "interval",
"value": "",
"type": "query",
"description": "Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to."
}
]
},
"docs": "Get List of Site Rogue Clients"
},
{
"info": {
"name": "countSiteRogueEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rogues/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID of the network detected as threat"
},
{
"name": "bssid",
"value": "",
"type": "query",
"description": "BSSID of the network detected as threat"
},
{
"name": "ap_mac",
"value": "",
"type": "query",
"description": "MAC of the device that had strongest signal strength for ssid/bssid pair"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "Channel over which ap_mac heard ssid/bssid pair"
},
{
"name": "seen_on_lan",
"value": "",
"type": "query",
"description": "Whether the reporting AP see a wireless client (on LAN) connecting to it"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Rogue Events"
},
{
"info": {
"name": "searchSiteRogueEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rogues/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID of the network detected as threat"
},
{
"name": "bssid",
"value": "",
"type": "query",
"description": "BSSID of the network detected as threat"
},
{
"name": "ap_mac",
"value": "",
"type": "query",
"description": "MAC of the device that had strongest signal strength for ssid/bssid pair"
},
{
"name": "channel",
"value": "",
"type": "query",
"description": "Channel over which ap_mac heard ssid/bssid pair"
},
{
"name": "seen_on_lan",
"value": "",
"type": "query",
"description": "Whether the reporting AP see a wireless client (on LAN) connecting to it"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Rogue Events"
},
{
"info": {
"name": "getSiteRogueAP",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rogues/:rogue_bssid",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rogue_bssid",
"value": "",
"type": "path"
}
]
},
"docs": "Get Rogue AP Details"
}
]
},
{
"info": {
"name": "Sites Stats - IoT Endpoints",
"type": "folder"
},
"items": [
{
"info": {
"name": "searchSiteIotEndpoints",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/iotendpoints/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "ap_mac",
"value": "",
"type": "query",
"description": "AP MAC address"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device MAC address"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "IoT endpoint type. enum: `zigbee`"
},
{
"name": "mfg",
"value": "",
"type": "query",
"description": "Manufacturer name"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Search IoT Endpoints"
}
]
},
{
"info": {
"name": "Sites Licenses",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteLicenseUsage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/licenses/usages",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This shows license usage (i.e. needed) based on the features enabled for the site."
}
]
},
{
"info": {
"name": "Sites Location",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteBeamCoverageOverview",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/coverage",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "00000000-0000-0000-0000-000000000000",
"type": "query",
"description": "Map_id (filter by map_id)"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "client_type",
"value": "",
"type": "query",
"description": "Client_type (as filter. optional)"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "resolution",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get Beam Coverage Overview"
},
{
"info": {
"name": "getSiteMachineLearningCurrentStat",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/current",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "00000000-0000-0000-0000-000000000000",
"type": "query",
"description": "Map_id (as filter, optional)"
}
]
},
"docs": "Get Machine Learning Current Stat\nFor each VBLE AP, it has ML model parameters (e.g. Path-loss-estimate, Intercept) as well as completion indicators (Level and PercentageComplete). For the completeness, ML takes N sample to finish its first level and use N*0.25 samples to complete each successive level. When a device is moved, the completeness will be reset as it has to re-learn."
},
{
"info": {
"name": "getSiteDefaultPlfForModels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/defaults",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Default PLF for Models"
},
{
"info": {
"name": "overwriteSiteMlForDevice",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/device/:device_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Overwrite ML For Device"
},
{
"info": {
"name": "clearSiteMlOverwriteForDevice",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/device/:device_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Clear ML Overwrite for Device"
},
{
"info": {
"name": "overwriteSiteMlForMap",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/map/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Overwrite ML For Map"
},
{
"info": {
"name": "clearSiteMlOverwriteForMap",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/map/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Clear ML Overwrite for Map"
},
{
"info": {
"name": "resetSiteMlStatsByMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/location/ml/reset/map/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Reset ML Stats by Map"
}
]
},
{
"info": {
"name": "Sites Maps",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteMaps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Maps"
},
{
"info": {
"name": "createSiteMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site Map"
},
{
"info": {
"name": "startSiteMapsAutoGeofence",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/auto_geofences",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as \"geofences\". This API processes all maps for a given SiteId. The maps must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected."
},
{
"info": {
"name": "importSiteMaps",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/import",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Import data from files is a multipart POST which has an file, an optional json, and an optional csv, to create floorplan, assign matching inventory to specific site, place ap if name or mac matches.\n\n# Note\nThis endpoint (at the site level), the AP must be already assigned to the site to be placed on the floorplan. If you want to place APs from the Org inventory, it is required to use the endpoint at the Org level [importOrgMaps](#operation/importOrgMaps)\n\n# CSV File Format\n```csv\nVendor AP name"
},
{
"info": {
"name": "getSiteMap",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Map Details"
},
{
"info": {
"name": "updateSiteMap",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Map"
},
{
"info": {
"name": "deleteSiteMap",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Map"
},
{
"info": {
"name": "startSiteMapAutoGeofence",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_geofences",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "The auto geofence service is a map parsing service that uses map image data to identify the exterior of buildings in the map image also known as \"geofences\". This API processes a single given MapId. This map must have an image to parse for the auto geofence service. Repeated POST requests to this endpoint while the auto geofence service is processing the map will be rejected."
},
{
"info": {
"name": "addSiteMapImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/image",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Add image map is a multipart POST which has an file (Image) and an optional json parameter"
},
{
"info": {
"name": "deleteSiteMapImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/image",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Map Image"
},
{
"info": {
"name": "replaceSiteMapImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/replace",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "Replace Map Image\n\n\nThis works like an PUT where the image will be replaced. If transform is provided, all the locations of the objects on the map (AP, Zone, Vbeacon, Beacon) will be transformed as well (relative to the new Map)"
},
{
"info": {
"name": "bulkAssignSiteApsToMap",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/set_map",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API can be used to assign a list of AP Macs associated with site_id to the specified map_id. Note that map_id must be associated with corresponding site_id. This API obeys the following rules \n1. if AP is unassigned to any Map, it gets associated with map_id \n2. Any moved APs are returned in the response \n3. If the AP is considered a locked AP, no action will be taken"
},
{
"info": {
"name": "importSiteWayfindings",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/wayfinding/import",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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."
}
]
},
{
"info": {
"name": "Sites Maps - Auto-placement",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteApAutoOrientation",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_orient",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API is called to view the current status of auto orient for a given map."
},
{
"info": {
"name": "startSiteApAutoOrientation",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_orient",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is called to trigger a map for auto orient. For auto orient feature to work, BLE data needs to be collected from the APs on the map. This precess is not disruptive unlike FTM collection. Repeated POST requests to this endpoint while a map is still running will be rejected.\n\n\n`force_collection` is set to `false` by default. If `force_collection`==`false`, the API attempts to start orientation with existing data. If no data exists, the API attempts to start collecting orientation data. If"
},
{
"info": {
"name": "deleteSiteApAutoOrientation",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_orient",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API is called to force stop auto placement for a given map"
},
{
"info": {
"name": "getSiteApAutoplacement",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_placement",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API is called to view the current status of auto placement for a given map.\n\n\n#### Status Descriptions\n\n| Status | Description |\n| --- | --- |\n| `pending` | Autoplacement has not been requested for this map |\n| `inprogress` | Autoplacement is currently processing |\n| `done` | The autoplacement process has completed |\n| `data_needed` | Additional position data is required for autoplacement. Users should verify the requested anchor APs have a position on the map |\n| `invalid_model` | Autoplac"
},
{
"info": {
"name": "runSiteApAutoplacement",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_placement",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is called to trigger auto placement for a map. For the auto placement feature to work, RTT-FTM data needs to be collected from the APs on the map. \nThis scan is disruptive, and users must be notified of service disruption during the auto placement process. Repeated POST requests to this endpoint while a map is still running will be rejected.\n\n\n`force_collection` is set to `false` by default. If `force_collection` is set to `false`, the API attempts to start localization with existing d"
},
{
"info": {
"name": "deleteSiteApAutoplacement",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_placement",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API is called to force stop auto placement for a given map"
},
{
"info": {
"name": "clearSiteApAutoOrient",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/clear_auto_orient",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is used to destroy the autoorientations of a map or subset of APs on a map."
},
{
"info": {
"name": "clearSiteApAutoplacement",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/clear_autoplacement",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is used to destroy the cached autoplacement locations of a map or subset of APs on a map."
},
{
"info": {
"name": "confirmSiteApLocalizationData",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/use_auto_ap_values",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API is used to accept or reject the cached autoplacement and auto-orientation values of a map or subset of APs on a map. Any APs that have autoplacement values are stored in cache for up to 7 days while awaiting acceptance or rejection.\n\n```\nAccepting the autoplacement values overwrites the existing X, Y, and orientation of the accepted APs with their cached autoplacement values.\nRejecting the autoplacement values causes the APs to retain their current X, Y, and orientation.\n```\n\nOnce a dec"
}
]
},
{
"info": {
"name": "Sites Maps - Auto-Zone",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteMapAutoZoneStatus",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_zones",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API provides the current status of the auto zones service for a given map"
},
{
"info": {
"name": "startSiteMapAutoZone",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_zones",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is processing the map will be rejected."
},
{
"info": {
"name": "deleteSiteMapAutoZone",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/maps/:map_id/auto_zones",
"params": [
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "This API starts the auto zones service for a specified map. This map must have an image to parse for the auto zones service. Repeated POST requests to this endpoint while the auto zones service is processing the map or awaiting review will be rejected."
}
]
},
{
"info": {
"name": "Sites Map Stacks",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteMapStacks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mapstacks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Filter by map stack name"
}
]
},
"docs": "Get List of Site Map Stacks"
},
{
"info": {
"name": "createSiteMapStack",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/mapstacks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site Map Stack"
}
]
},
{
"info": {
"name": "Sites MxEdges",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteMxEdges",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Mist Edges"
},
{
"info": {
"name": "countSiteMxEdgeEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "service",
"value": "",
"type": "query",
"description": "Service running on mist edge(mxagent, tunterm etc)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Mist Edge Events"
},
{
"info": {
"name": "searchSiteMistEdgeEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "query",
"description": "Mist edge id"
},
{
"name": "mxcluster_id",
"value": "",
"type": "query",
"description": "Mist edge cluster id"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "service",
"value": "",
"type": "query",
"description": "Service running on mist edge(mxagent, tunterm etc)"
},
{
"name": "component",
"value": "",
"type": "query",
"description": "Component like PS1, PS2"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site Mist Edge Events"
},
{
"info": {
"name": "getSiteMxEdge",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/:mxedge_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Mist Edge"
},
{
"info": {
"name": "updateSiteMxEdge",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/:mxedge_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Mist Edge settings"
},
{
"info": {
"name": "deleteSiteMxEdge",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/:mxedge_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Mist Edge"
},
{
"info": {
"name": "uploadSiteMxEdgeSupportFiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxedges/:mxedge_id/support",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
}
]
},
"docs": "Support / Upload Mist Edge support files"
}
]
},
{
"info": {
"name": "Utilities MxEdge",
"type": "folder"
},
"items": [
{
"info": {
"name": "preemptSitesMxTunnel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/mxtunnels/:mxtunnel_id/preempt_aps",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxtunnel_id",
"value": "",
"type": "path"
}
]
},
"docs": "To preempt AP’s which are not connected to preferred peer to the preferred peer"
}
]
},
{
"info": {
"name": "Sites Clients - NAC",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteNacClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "last_nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "last_vlan_id",
"value": "",
"type": "query",
"description": "Vlan ID"
},
{
"name": "last_nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "last_ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "last_username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "last_ap",
"value": "",
"type": "query",
"description": "AP MAC connected to by client"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "last_status",
"value": "",
"type": "query",
"description": "Connection status of client i.e \"permitted\", \"denied, \"session_ended\""
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Client type i.e. \"wireless\", \"wired\" etc."
},
{
"name": "mdm_compliance_status",
"value": "",
"type": "query",
"description": "MDM compliance of client i.e \"compliant\", \"not compliant\""
},
{
"name": "mdm_provider",
"value": "",
"type": "query",
"description": "MDM provider of client’s organisation eg \"intune\", \"jamf\""
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of NAC Clients"
},
{
"info": {
"name": "countSiteNacClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of NAC Client-Events"
},
{
"info": {
"name": "searchSiteNacClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "dryrun_nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Dry Run Rule ID, if present and matched"
},
{
"name": "dryrun_nacrule_matched",
"value": "",
"type": "query",
"description": "True - if dryrun rule present and matched with priority, False - if not matched or not present"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "Vlan ID"
},
{
"name": "nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "bssid",
"value": "",
"type": "query",
"description": "BSSID"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "idp_role",
"value": "",
"type": "query",
"description": "IDP returned roles/groups for the user"
},
{
"name": "idp_username",
"value": "",
"type": "query",
"description": "Username presented to the Identity Provider"
},
{
"name": "resp_attrs",
"value": "",
"type": "query",
"description": "Radius attributes returned by NAC to NAS Devive"
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "ap",
"value": "",
"type": "query",
"description": "AP MAC"
},
{
"name": "random_mac",
"value": "",
"type": "query",
"description": "AP random macMAC"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Time, in epoch"
},
{
"name": "usermac_label",
"value": "",
"type": "query",
"description": "Labels derived from usermac entry"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Partial / full MAC address, username, device_mac or ap. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported"
},
{
"name": "nas_ip",
"value": "",
"type": "query",
"description": "IP address of NAS device"
},
{
"name": "ingress_vlan",
"value": "",
"type": "query",
"description": "Vendor specific Vlan ID in radius requests"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order."
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search NAC Client Events"
},
{
"info": {
"name": "searchSiteNacClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "ap",
"value": "",
"type": "query",
"description": "MAC Address of the AP the client is/was connected to"
},
{
"name": "auth_type",
"value": "",
"type": "query",
"description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\""
},
{
"name": "cert_expiry_duration",
"value": "",
"type": "query",
"description": "Filter by certificate expiry within a specific duration from now (e.g., \"7d\" for 7 days, \"1m\" for 1 month)"
},
{
"name": "edr_managed",
"value": "",
"type": "query",
"description": "Filters NAC clients that are integrated with EDR providers"
},
{
"name": "edr_provider",
"value": "",
"type": "query",
"description": "EDR provider of client's organization"
},
{
"name": "edr_status",
"value": "",
"type": "query",
"description": "EDR Status of the NAC client"
},
{
"name": "family",
"value": "",
"type": "query",
"description": "Partial / full Client family (e.g. \"Phone/Tablet/Wearable\", \"Access Point\"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Surveillance*` and `*urveillance*` match `Surveillance Camera`). Suffix-only wildcards (e.g. `*Camera`) are not supported"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported"
},
{
"name": "idp_id",
"value": "",
"type": "query",
"description": "SSO ID, if present and used"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Partial / full Client MAC Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported"
},
{
"name": "mdm_compliance",
"value": "",
"type": "query",
"description": "MDM compliance of client i.e \"compliant\", \"not compliant\""
},
{
"name": "mdm_provider",
"value": "",
"type": "query",
"description": "MDM provider of client’s organization eg \"intune\", \"jamf\""
},
{
"name": "mdm_managed",
"value": "",
"type": "query",
"description": "Filters NAC clients that are managed by MDM providers"
},
{
"name": "mfg",
"value": "",
"type": "query",
"description": "Partial / full Client manufacturer (e.g. \"apple\", \"cisco\", \"juniper\"). Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `Raspberry Pi*` and `*Pi*` match `Raspberry Pi Trading Ltd`). Suffix-only wildcards (e.g. `*Ltd`) are not supported"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Client model, e.g. \"iPhone 12\", \"MX100\""
},
{
"name": "nacrule_name",
"value": "",
"type": "query",
"description": "NAC Policy Rule Name matched"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "NAC Policy Rule ID, if matched"
},
{
"name": "nacrule_matched",
"value": "",
"type": "query",
"description": "NAC Policy Rule Matched"
},
{
"name": "nas_vendor",
"value": "",
"type": "query",
"description": "Vendor of NAS device"
},
{
"name": "nas_ip",
"value": "",
"type": "query",
"description": "IP address of NAS device"
},
{
"name": "ingress_vlan",
"value": "",
"type": "query",
"description": "Vendor specific Vlan ID in radius requests"
},
{
"name": "os",
"value": "",
"type": "query",
"description": "Client OS, e.g. \"iOS 18.1\", \"Android\", \"Windows\", \"Linux\""
},
{
"name": "ssid",
"value": "",
"type": "query",
"description": "SSID"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Connection status of client i.e \"permitted\", \"denied, \"session_started\", \"session_stopped\""
},
{
"name": "text",
"value": "",
"type": "query",
"description": "partial / full MAC address, last_username, device_mac, nas_ip. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported."
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Client type i.e. \"wireless\", \"wired\" etc."
},
{
"name": "usermac_label",
"value": "",
"type": "query",
"description": "Labels derived from usermac entry"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "Username presented by the client"
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "Vlan name or ID assigned to the client"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order."
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site NAC Clients"
},
{
"info": {
"name": "sendSiteNacClientCoA",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/:client_mac/coa",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "client_mac",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sends CoA (Change of Authorization) command to a NAC client."
}
]
},
{
"info": {
"name": "Sites Networks",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteNetworksDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/networks/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Networks for a Site"
}
]
},
{
"info": {
"name": "Sites Network Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteNetworkTemplatesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/networktemplates/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Network Templates a Site"
}
]
},
{
"info": {
"name": "Sites Devices - Others",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteOtherDevices",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/otherdevices",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "vendor",
"value": "",
"type": "query"
},
{
"name": "mac",
"value": "",
"type": "query"
},
{
"name": "serial",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query"
},
{
"name": "name",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site other devices (3rd party devices)"
},
{
"info": {
"name": "countSiteOtherDeviceEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/otherdevices/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listOtherDeviceEventsDefinitions)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Site OtherDevices Events"
},
{
"info": {
"name": "searchSiteOtherDeviceEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/otherdevices/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "MAC of attached device"
},
{
"name": "vendor",
"value": "",
"type": "query",
"description": "Vendor name"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listOtherDeviceEventsDefinitions)"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site OtherDevices Events"
}
]
},
{
"info": {
"name": "Sites Psks",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSitePsks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "ssid",
"value": "",
"type": "query"
},
{
"name": "role",
"value": "",
"type": "query"
},
{
"name": "name",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site PSKs"
},
{
"info": {
"name": "createSitePsk",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site PSK\n\n\nWhen `usage`==`macs`, corresponding \"macs\" field will hold a list consisting of client mac addresses ([\"xx:xx:xx:xx:xx\",...]) or mac patterns([\"xx:xx:*\",\"xx*\",...]) or both ([\"xx:xx:xx:xx:xx:xx\", \"xx:*\", ...]). This list is capped at 5000"
},
{
"info": {
"name": "updateSiteMultiplePsks",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update multiple PSKs"
},
{
"info": {
"name": "importSitePsks",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks/import",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import PSK from CSV file or JSON\n\n## CSV File Format\n```csv\nPSK Import CSV File Format:\nname,ssid,passphrase,usage,vlan_id,mac\nCommon,warehouse,foryoureyesonly,single,35,a31425f31278\nJustin,reception,visible,multi,1002\n```"
},
{
"info": {
"name": "getSitePsk",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks/:psk_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "psk_id",
"value": "",
"type": "path",
"description": "PSK ID"
}
]
},
"docs": "Get Site PSK Details"
},
{
"info": {
"name": "updateSitePsk",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks/:psk_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "psk_id",
"value": "",
"type": "path",
"description": "PSK ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site PSK"
},
{
"info": {
"name": "deleteSitePsk",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/psks/:psk_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "psk_id",
"value": "",
"type": "path",
"description": "PSK ID"
}
]
},
"docs": "Delete Site PSK"
}
]
},
{
"info": {
"name": "Sites Rfdiags",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "List RF Glass Recording"
},
{
"info": {
"name": "startSiteRecording",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Start RF Glass Recording"
},
{
"info": {
"name": "getSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags/:rfdiag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rfdiag_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get RF Diag Recording Details"
},
{
"info": {
"name": "updateSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags/:rfdiag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rfdiag_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Recording"
},
{
"info": {
"name": "deleteSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags/:rfdiag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rfdiag_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Recording"
},
{
"info": {
"name": "downloadSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags/:rfdiag_id/download",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rfdiag_id",
"value": "",
"type": "path"
}
]
},
"docs": "Download Recording\nDownload raw_events blob"
},
{
"info": {
"name": "stopSiteRfdiagRecording",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/rfdiags/:rfdiag_id/stop",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rfdiag_id",
"value": "",
"type": "path"
}
]
},
"docs": "If the recording session is active for the given rfdiag_id, it will finish the recording. duration and end_time will be updated to reflect the correct values."
}
]
},
{
"info": {
"name": "Sites RF Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteRfTemplatesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rftemplates/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived RF Templates a Site"
}
]
},
{
"info": {
"name": "Sites RRM",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteChannelScores",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rrm/channel_scores/band/:band",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "band",
"value": "",
"type": "path",
"description": "802.11 Band"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Get Site Channel Scores"
},
{
"info": {
"name": "getSiteCurrentChannelPlanning",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rrm/current",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Current Channel Planning"
},
{
"info": {
"name": "getSiteCurrentRrmConsiderations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rrm/current/devices/:device_id/band/:band",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "band",
"value": "",
"type": "path",
"description": "802.11 Band"
}
]
},
"docs": "Get Current RRM Considerations for an AP on a Specific Band"
},
{
"info": {
"name": "listSiteRrmEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rrm/events",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "band",
"value": "",
"type": "query",
"description": "802.11 Band"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "List Site RRM Events"
},
{
"info": {
"name": "listSiteCurrentRrmNeighbors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rrm/neighbors/band/:band",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "band",
"value": "",
"type": "path",
"description": "802.11 Band"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "List Current RRM observed neighbors"
}
]
},
{
"info": {
"name": "Sites RSSI Zones",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteRssiZones",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rssizones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site RSSI Zone (RSSI-based)"
},
{
"info": {
"name": "createSiteRssiZone",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/rssizones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create RSSI Zone"
},
{
"info": {
"name": "getSiteRssiZone",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/rssizones/:rssizone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rssizone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site RSSI Zone details"
},
{
"info": {
"name": "updateSiteRssiZone",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/rssizones/:rssizone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rssizone_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site RSSI Zone"
},
{
"info": {
"name": "deleteSiteRssiZone",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/rssizones/:rssizone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "rssizone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site RSSI Zone"
}
]
},
{
"info": {
"name": "Sites SecIntel Profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteSecIntelProfilesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/secintelprofiles/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Sky-ATP secintel profiles a Site"
}
]
},
{
"info": {
"name": "Sites Service Policies",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteServicePoliciesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/servicepolicies/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Service Policies for a Site"
}
]
},
{
"info": {
"name": "Sites Services",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteServicesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/services/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Services for a Site"
},
{
"info": {
"name": "countSiteServicePathEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/services/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type, e.g. GW_SERVICE_PATH_DOWN"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Description of the event including the reason it is triggered"
},
{
"name": "vpn_name",
"value": "",
"type": "query",
"description": "Peer name"
},
{
"name": "vpn_path",
"value": "",
"type": "query",
"description": "Peer path name"
},
{
"name": "policy",
"value": "",
"type": "query",
"description": "Service policy associated with that specific path"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Network interface"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Device firmware version"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Service Path Events"
},
{
"info": {
"name": "searchSiteServicePathEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/services/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type, e.g. GW_SERVICE_PATH_DOWN"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Description of the event including the reason it is triggered"
},
{
"name": "peer_port_id",
"value": "",
"type": "query",
"description": "Port ID of the peer gateway"
},
{
"name": "peer_mac",
"value": "",
"type": "query",
"description": "MAC address of the peer gateway"
},
{
"name": "vpn_name",
"value": "",
"type": "query",
"description": "Peer name"
},
{
"name": "vpn_path",
"value": "",
"type": "query",
"description": "Peer path name"
},
{
"name": "policy",
"value": "",
"type": "query",
"description": "Service policy associated with that specific path"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Network interface"
},
{
"name": "model",
"value": "",
"type": "query",
"description": "Device model"
},
{
"name": "version",
"value": "",
"type": "query",
"description": "Device firmware version"
},
{
"name": "timestamp",
"value": "",
"type": "query",
"description": "Start time, in epoch"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Service Path Events"
}
]
},
{
"info": {
"name": "Sites Setting",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteSetting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the Site Settings"
},
{
"info": {
"name": "updateSiteSettings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Settings"
},
{
"info": {
"name": "createSiteWirelessClientsBlocklist",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/blacklist",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint is to provide list of client macs for annotation blacklist.\n\nRetrieve the current clients list `blacklist_url` under Site:Setting"
},
{
"info": {
"name": "deleteSiteWirelessClientsBlocklist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/blacklist",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Blacklist Station Clients"
},
{
"info": {
"name": "getSiteSettingDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the Derived Site Settings, generated by merging the Org level templates (network templates, gateway templates) and the Site level configuration. If the same parameter is defined in both scopes, the Site level one is used. In addition, the Zoom and Teams accounts are also merged into the derived settings."
},
{
"info": {
"name": "createSiteWatchedStations",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/watched_station",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint is to provide list of client macs for annotation as watched station.\n\nRetrieve the current clients list from `watched_station_url` under Site:Setting"
},
{
"info": {
"name": "deleteSiteWatchedStations",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/watched_station",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Watched Station Clients"
},
{
"info": {
"name": "createSiteWirelessClientsAllowlist",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/whitelist",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint is to provide list of client macs for annotation as whitelist.\n\nRetrieve the current clients list from `whitelist_url` under Site:Setting"
},
{
"info": {
"name": "deleteSiteWirelessClientsAllowlist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/whitelist",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Whitelist Station Clients"
}
]
},
{
"info": {
"name": "Sites JSE",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteJseInfo",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/setting/jse/info",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Retrieves the list of JSE orgs associated with the account"
}
]
},
{
"info": {
"name": "Sites Site Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteSiteTemplatesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sitetemplates/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived Site Templates for Site"
}
]
},
{
"info": {
"name": "Sites Skyatp",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteSkyatpEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/skyatp/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type, e.g. cc, fs, mw"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Client MAC"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "Device MAC"
},
{
"name": "threat_level",
"value": "",
"type": "query",
"description": "Threat level"
},
{
"name": "ip",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Skyatp Events (WIP)"
},
{
"info": {
"name": "searchSiteSkyatpEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/skyatp/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Event type, e.g. cc, fs, mw"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Client MAC"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "Device MAC"
},
{
"name": "threat_level",
"value": "",
"type": "query",
"description": "Threat level"
},
{
"name": "ip",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Skyatp Events (WIP)"
}
]
},
{
"info": {
"name": "Sites SLEs",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteSleClassifierDetails",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifier/:classifier/summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "classifier",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get SLE classifier details\n\n\nThis API Endpoint is deprecated and replaced by [Get Site SLE Classifier Summary Trend](/#operations/getSiteSleClassifierSummaryTrend)"
},
{
"info": {
"name": "getSiteSleClassifierSummaryTrend",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifier/:classifier/summary-trend",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "classifier",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get SLE classifier Summary Trend"
},
{
"info": {
"name": "listSiteSleMetricClassifiers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifiers",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
}
]
},
"docs": "List classifiers for a specific metric"
},
{
"info": {
"name": "getSiteSleHistogram",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/histogram",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get the histogram for the SLE metric"
},
{
"info": {
"name": "getSiteSleImpactSummary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impact-summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "fields",
"value": "",
"type": "query"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "Get impact summary counts optionally filtered by classifier and failure type\n \n* Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge`\n* Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis`\n* WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`"
},
{
"info": {
"name": "listSiteSleImpactedApplications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-applications",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedAps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-aps",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wireless SLEs. List the impacted APs optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedChassis",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-chassis",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedWiredClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wired SLEs. List the impacted interfaces optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedGateways",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-gateways",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedInterfaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-interfaces",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedSwitches",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-switches",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wired SLEs. List the impacted switches optionally filtered by classifier and failure type"
},
{
"info": {
"name": "listSiteSleImpactedWirelessClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-users",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "classifier",
"value": "",
"type": "query"
}
]
},
"docs": "For Wireless SLEs. List the impacted wireless users optionally filtered by classifier and failure type"
},
{
"info": {
"name": "getSiteSleSummary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get the summary for the SLE metric\n\n\nThis API Endpoint is deprecated and replaced by [Get Site SLE Summary Trend](/#operations/getSiteSleSummaryTrend)"
},
{
"info": {
"name": "getSiteSleSummaryTrend",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/summary-trend",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get the summary for the SLE metric trend"
},
{
"info": {
"name": "getSiteSleThreshold",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
}
]
},
"docs": "Get the SLE threshold"
},
{
"info": {
"name": "replaceSiteSleThreshold",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Replace the SLE threshold"
},
{
"info": {
"name": "updateSiteSleThreshold",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
},
{
"name": "metric",
"value": "",
"type": "path",
"description": "Values from `listSiteSlesMetrics`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the SLE threshold"
},
{
"info": {
"name": "listSiteSlesMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metrics",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "path"
},
{
"name": "scope_id",
"value": "",
"type": "path",
"description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`"
}
]
},
"docs": "List the metrics for the given scope"
}
]
},
{
"info": {
"name": "Sites Stats",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Sites Stats"
}
]
},
{
"info": {
"name": "Sites Stats - Apps",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteApps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/apps/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query",
"description": "Default for wireless devices is `ap`. Default for wired devices is `device_mac`"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "MAC of the device"
},
{
"name": "app",
"value": "",
"type": "query",
"description": "Application name"
},
{
"name": "wired",
"value": "",
"type": "query",
"description": "If a device is wired or wireless. Default is False."
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Applications"
}
]
},
{
"info": {
"name": "Sites Stats - Assets",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteAssetsStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/assets",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Assets Stats"
},
{
"info": {
"name": "countSiteAssets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/assets/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Site Asset"
},
{
"info": {
"name": "searchSiteAssets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/assets/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query"
},
{
"name": "map_id",
"value": "",
"type": "query"
},
{
"name": "ibeacon_uuid",
"value": "",
"type": "query"
},
{
"name": "ibeacon_major",
"value": "",
"type": "query"
},
{
"name": "ibeacon_minor",
"value": "",
"type": "query"
},
{
"name": "eddystone_uid_namespace",
"value": "",
"type": "query"
},
{
"name": "eddystone_uid_instance",
"value": "",
"type": "query"
},
{
"name": "eddystone_url",
"value": "",
"type": "query"
},
{
"name": "device_name",
"value": "",
"type": "query"
},
{
"name": "by",
"value": "",
"type": "query"
},
{
"name": "name",
"value": "",
"type": "query"
},
{
"name": "ap_mac",
"value": "",
"type": "query"
},
{
"name": "beam",
"value": "",
"type": "query"
},
{
"name": "rssi",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Assets Search"
},
{
"info": {
"name": "getSiteAssetStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/assets/:asset_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "asset_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get Site Asset Details"
},
{
"info": {
"name": "listSiteDiscoveredAssets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/discovered_assets",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Discovered BLE Assets that doesn’t match any of the Asset / Assetfilters"
},
{
"info": {
"name": "getSiteAssetsOfInterest",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/filtered_assets",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get a list of BLE beacons that matches Asset or AssetFilter"
},
{
"info": {
"name": "getSiteDiscoveredAssetByMap",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/maps/:map_id/discovered_assets",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get a list of BLE beacons that we discovered (whether they’ re defined as assets or not)"
}
]
},
{
"info": {
"name": "Sites Stats - Beacons",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteBeaconsStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/beacons",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Beacons Stats"
}
]
},
{
"info": {
"name": "Sites Stats - BGP Peers",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteBgpStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/bgp_peers/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "state",
"value": "",
"type": "query"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of BGP Stats"
},
{
"info": {
"name": "searchSiteBgpStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/bgp_peers/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query"
},
{
"name": "neighbor_mac",
"value": "",
"type": "query"
},
{
"name": "vrf_name",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search BGP Stats"
}
]
},
{
"info": {
"name": "Sites Stats - Calls",
"type": "folder"
},
"items": [
{
"info": {
"name": "troubleshootSiteCall",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/calls/client/:client_mac/troubleshoot",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "client_mac",
"value": "",
"type": "path"
},
{
"name": "meeting_id",
"value": "",
"type": "query",
"description": "meeting_id"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device identifier"
},
{
"name": "app",
"value": "",
"type": "query",
"description": "Third party app name"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Troubleshoot a call"
},
{
"info": {
"name": "countSiteCalls",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/calls/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "rating",
"value": "",
"type": "query",
"description": "Feedback rating (e.g. \"rating=1\" or \"rating=1,2\")"
},
{
"name": "app",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Calls"
},
{
"info": {
"name": "searchSiteCalls",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/calls/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device identifier"
},
{
"name": "app",
"value": "",
"type": "query",
"description": "Third party app name"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Calls"
},
{
"info": {
"name": "getSiteCallsSummary",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/calls/summary",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "ap_mac",
"value": "",
"type": "query",
"description": "AP MAC, optional"
},
{
"name": "app",
"value": "",
"type": "query",
"description": "APp name (`zoom` or `teams`). default is both. Optional"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
}
]
},
"docs": "Summarized, aggregated stats for the site calls"
},
{
"info": {
"name": "listSiteTroubleshootCalls",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/calls/troubleshoot",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "ap",
"value": "",
"type": "query",
"description": "AP MAC"
},
{
"name": "meeting_id",
"value": "",
"type": "query",
"description": "meeting_id"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device identifier"
},
{
"name": "app",
"value": "",
"type": "query",
"description": "Third party app name"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Summary of calls troubleshoot by site"
}
]
},
{
"info": {
"name": "Sites Stats - Clients Wireless",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWirelessClientsStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wired",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get List of Site All Clients Stats Details"
},
{
"info": {
"name": "getSiteWirelessClientStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/clients/:client_mac",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "client_mac",
"value": "",
"type": "path"
},
{
"name": "wired",
"value": "",
"type": "query"
}
]
},
"docs": "Get Site Client Stats Details"
},
{
"info": {
"name": "getSiteWirelessClientsStatsByMap",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/maps/:map_id/clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get Site Clients Stats By Map"
},
{
"info": {
"name": "listSiteUnconnectedClientStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/maps/:map_id/unconnected_clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Site Unconnected Client Location"
}
]
},
{
"info": {
"name": "Sites Stats - Devices",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteDevicesStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/devices",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "status",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Devices Stats"
},
{
"info": {
"name": "getSiteDeviceStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/devices/:device_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "List of additional fields requests, comma separated, or `fields=*` for all of them"
}
]
},
"docs": "Get Site Device Stats Details"
},
{
"info": {
"name": "getSiteAllClientsStatsByDevice",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/devices/:device_id/clients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get wireless client stat by Device"
},
{
"info": {
"name": "getSiteGatewayMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/gateways/metrics",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Gateway Metrics"
},
{
"info": {
"name": "getSiteSwitchesMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/switches/metrics",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "scope",
"value": "",
"type": "query"
},
{
"name": "switch_mac",
"value": "",
"type": "query",
"description": "Switch mac, used only with metric `type`==`active_ports_summary`"
}
]
},
"docs": "Get version compliance metrics for managed or monitored switches"
}
]
},
{
"info": {
"name": "Sites Stats - Discovered Switches",
"type": "folder"
},
"items": [
{
"info": {
"name": "searchSiteDiscoveredSwitchesMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/discovered_switch_metrics/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Metric scope"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Metric type"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Discovered Switch Metrics"
},
{
"info": {
"name": "countSiteDiscoveredSwitches",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/discovered_switches/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count Discovered Switches"
},
{
"info": {
"name": "listSiteDiscoveredSwitchesMetrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/discovered_switches/metrics",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "threshold",
"value": "",
"type": "query",
"description": "Configurable # ap per switch threshold, default 12"
},
{
"name": "system_name",
"value": "",
"type": "query",
"description": "System name for switch level metrics, optional"
}
]
},
"docs": "Discovered switches related metrics, lists related switch system names & details if not compliant"
},
{
"info": {
"name": "searchSiteDiscoveredSwitches",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/discovered_switches/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "adopted",
"value": "",
"type": "query"
},
{
"name": "system_name",
"value": "",
"type": "query"
},
{
"name": "hostname",
"value": "",
"type": "query"
},
{
"name": "vendor",
"value": "",
"type": "query"
},
{
"name": "model",
"value": "",
"type": "query"
},
{
"name": "version",
"value": "",
"type": "query"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Discovered Switches"
}
]
},
{
"info": {
"name": "Sites Stats - Clients SDK",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteSdkStatsByMap",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/maps/:map_id/sdkclients",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get SdkClient Stats By Map"
},
{
"info": {
"name": "getSiteSdkStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/sdkclients/:sdkclient_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "sdkclient_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Detail Stats of a SdkClient"
}
]
},
{
"info": {
"name": "Sites Stats - MxEdges",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteMxEdgesStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/mxedges",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site MxEdges Stats"
},
{
"info": {
"name": "getSiteMxEdgeStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/mxedges/:mxedge_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mxedge_id",
"value": "",
"type": "path"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
}
]
},
"docs": "Get One Site MxEdge Stats"
}
]
},
{
"info": {
"name": "Sites Stats - Ospf",
"type": "folder"
},
"items": [
{
"info": {
"name": "countOrgOspfStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/ospf_peers/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Count by Distinct Attributes of OSPF peers stats"
},
{
"info": {
"name": "searchSiteOspfStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/ospf_peers/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query"
},
{
"name": "vrf_name",
"value": "",
"type": "query"
},
{
"name": "peer_ip",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search OSPF Neighbor Stats"
}
]
},
{
"info": {
"name": "Sites Stats - Ports",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteSwOrGwPorts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/ports/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "full_duplex",
"value": "",
"type": "query",
"description": "Indicates full or half duplex"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device identifier"
},
{
"name": "neighbor_mac",
"value": "",
"type": "query",
"description": "Chassis identifier of the chassis type listed"
},
{
"name": "neighbor_port_desc",
"value": "",
"type": "query",
"description": "Description supplied by the system on the interface E.g. \"GigabitEthernet2/0/39\""
},
{
"name": "neighbor_system_name",
"value": "",
"type": "query",
"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \"Kumar-Acc-SW.mist.local\""
},
{
"name": "poe_disabled",
"value": "",
"type": "query",
"description": "Is the POE configured not be disabled."
},
{
"name": "poe_mode",
"value": "",
"type": "query",
"description": "POE mode depending on class E.g. \"802.3at\""
},
{
"name": "poe_on",
"value": "",
"type": "query",
"description": "Is the device attached to POE"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Interface name"
},
{
"name": "port_mac",
"value": "",
"type": "query",
"description": "Interface mac address"
},
{
"name": "power_draw",
"value": "",
"type": "query",
"description": "Amount of power being used by the interface at the time the command is executed. Unit in watts."
},
{
"name": "tx_pkts",
"value": "",
"type": "query",
"description": "Output packets"
},
{
"name": "rx_pkts",
"value": "",
"type": "query",
"description": "Input packets"
},
{
"name": "rx_bytes",
"value": "",
"type": "query",
"description": "Input bytes"
},
{
"name": "tx_bps",
"value": "",
"type": "query",
"description": "Output rate"
},
{
"name": "rx_bps",
"value": "",
"type": "query",
"description": "Input rate"
},
{
"name": "tx_mcast_pkts",
"value": "",
"type": "query",
"description": "Multicast output packets"
},
{
"name": "tx_bcast_pkts",
"value": "",
"type": "query",
"description": "Broadcast output packets"
},
{
"name": "rx_mcast_pkts",
"value": "",
"type": "query",
"description": "Multicast input packets"
},
{
"name": "rx_bcast_pkts",
"value": "",
"type": "query",
"description": "Broadcast input packets"
},
{
"name": "speed",
"value": "",
"type": "query",
"description": "Port speed"
},
{
"name": "stp_state",
"value": "",
"type": "query",
"description": "If `up`==`true`"
},
{
"name": "stp_role",
"value": "",
"type": "query",
"description": "If `up`==`true`"
},
{
"name": "auth_state",
"value": "",
"type": "query",
"description": "If `up`==`true` && has Authenticator role"
},
{
"name": "up",
"value": "",
"type": "query",
"description": "Indicates if interface is up"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Switch/Gateway Ports"
},
{
"info": {
"name": "searchSiteSwOrGwPorts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/ports/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_type",
"value": "",
"type": "query",
"description": "Type of device. enum: `switch`, `gateway`, `all`"
},
{
"name": "auth_state",
"value": "",
"type": "query",
"description": "If `up`==`true` && has Authenticator role"
},
{
"name": "full_duplex",
"value": "",
"type": "query",
"description": "Indicates full or half duplex"
},
{
"name": "lte_imsi",
"value": "",
"type": "query",
"description": "LTE IMSI value, Check for null/empty"
},
{
"name": "lte_iccid",
"value": "",
"type": "query",
"description": "LTE ICCID value, Check for null/empty"
},
{
"name": "lte_imei",
"value": "",
"type": "query",
"description": "LTE IMEI value, Check for null/empty"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Device identifier"
},
{
"name": "neighbor_mac",
"value": "",
"type": "query",
"description": "Chassis identifier of the chassis type listed"
},
{
"name": "neighbor_port_desc",
"value": "",
"type": "query",
"description": "Description supplied by the system on the interface E.g. \"GigabitEthernet2/0/39\""
},
{
"name": "neighbor_system_name",
"value": "",
"type": "query",
"description": "Name supplied by the system on the interface E.g. neighbor system name E.g. \"Kumar-Acc-SW.mist.local\""
},
{
"name": "poe_disabled",
"value": "",
"type": "query",
"description": "Is the POE configured not be disabled."
},
{
"name": "poe_mode",
"value": "",
"type": "query",
"description": "POE mode depending on class E.g. \"802.3at\""
},
{
"name": "poe_on",
"value": "",
"type": "query",
"description": "Is the device attached to POE"
},
{
"name": "poe_priority",
"value": "",
"type": "query",
"description": "PoE priority."
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Interface name"
},
{
"name": "port_mac",
"value": "",
"type": "query",
"description": "Interface mac address"
},
{
"name": "speed",
"value": "",
"type": "query",
"description": "Port speed"
},
{
"name": "stp_state",
"value": "",
"type": "query",
"description": "If `up`==`true`"
},
{
"name": "stp_role",
"value": "",
"type": "query",
"description": "If `up`==`true`"
},
{
"name": "up",
"value": "",
"type": "query",
"description": "Indicates if interface is up"
},
{
"name": "xcvr_part_number",
"value": "",
"type": "query",
"description": "Optic Slot Partnumber, Check for null/empty"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Switch / Gateway Ports Stats for a specific site.\nReturns a list of switch/gateway ports stats that match the search criteria.\n\nThe response provide current/last port status and statistics within the hour.\nTraffic information (Tx/Rx) are cumulative counters since the last device reboot."
}
]
},
{
"info": {
"name": "Sites Stats - Zones",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteRssiZonesStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/rssizones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get List of Site RSSI Zones Stats"
},
{
"info": {
"name": "getSiteRssiZoneStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/rssizones/:zone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Detail RSSI Zone Stats"
},
{
"info": {
"name": "listSiteZonesStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/zones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "map_id",
"value": "",
"type": "query"
},
{
"name": "min_duration",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Zones Stats"
},
{
"info": {
"name": "getSiteZoneStats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/zones/:zone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Detail Zone Stats"
}
]
},
{
"info": {
"name": "Sites Stats - WxRules",
"type": "folder"
},
"items": [
{
"info": {
"name": "getSiteWxRulesUsage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/stats/wxrules",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Wxlan Rule usage"
}
]
},
{
"info": {
"name": "Sites UI Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteUiSettings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "List the Site UI settings/databoard"
},
{
"info": {
"name": "createSiteUiSettings",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Site UI settings/databoard"
},
{
"info": {
"name": "listSiteUiSettingDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get both site UI settings(for_site=true) and org UI settings (for_site=false)"
},
{
"info": {
"name": "getSiteUiSetting",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings/:uisetting_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "uisetting_id",
"value": "",
"type": "path"
}
]
},
"docs": "Site UI settings"
},
{
"info": {
"name": "updateSiteUiSetting",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings/:uisetting_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "uisetting_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Site UI settings"
},
{
"info": {
"name": "deleteSiteUiSetting",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/uisettings/:uisetting_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "uisetting_id",
"value": "",
"type": "path"
}
]
},
"docs": "Site UI settings"
}
]
},
{
"info": {
"name": "Sites vBeacons",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteVBeacons",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/vbeacons",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Virtual Beacons"
},
{
"info": {
"name": "createSiteVBeacon",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/vbeacons",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Virtual Beacon"
},
{
"info": {
"name": "getSiteVBeacon",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/vbeacons/:vbeacon_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "vbeacon_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Virtual Beacon Details"
},
{
"info": {
"name": "updateSiteVBeacon",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/vbeacons/:vbeacon_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "vbeacon_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Virtual Beacon"
},
{
"info": {
"name": "deleteSiteVBeacon",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/vbeacons/:vbeacon_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "vbeacon_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Virtual Beacon"
}
]
},
{
"info": {
"name": "Sites VPNs",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteVpnsDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/vpns/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether resolve the site variables"
}
]
},
"docs": "Get the list of derived VPNs for a site"
}
]
},
{
"info": {
"name": "Sites Clients - Wan",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteWanClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_client/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Site WAN Client-Events"
},
{
"info": {
"name": "countSiteWanClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_clients/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Site WAN Clients"
},
{
"info": {
"name": "searchSiteWanClientEvents",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_clients/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Partial / full Client MAC Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `aabbcc*` and `*bbcc*` match `aabbccddeeff`). Suffix-only wildcards (e.g. `*bccddeeff`) are not supported"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported"
},
{
"name": "ip",
"value": "",
"type": "query",
"description": "Client IP"
},
{
"name": "mfg",
"value": "",
"type": "query",
"description": "Manufacture"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "nacrule_id"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site WAN Client Events"
},
{
"info": {
"name": "searchSiteWanClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_clients/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "hostname",
"value": "",
"type": "query",
"description": "Partial / full Client hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `everest*` and `*rest*` match `my-everest-client`). Suffix-only wildcards (e.g. `*everest`) are not supported"
},
{
"name": "ip",
"value": "",
"type": "query",
"description": "Partial / full Client IP Address. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `10.100.10.*` and `*100.10.*` match `10.100.10.54`). Suffix-only wildcards (e.g. `*.54`) are not supported"
},
{
"name": "ip_src",
"value": "",
"type": "query",
"description": "IP source"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Client MAC Address."
},
{
"name": "mfg",
"value": "",
"type": "query",
"description": "Manufacture"
},
{
"name": "network",
"value": "",
"type": "query",
"description": "Partial / full Name of the network the client is/was connected to. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-corp*` and `*corp*` match `my-corp-network`). Suffix-only wildcards (e.g. `*corp`) are not supported"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site WAN Clients"
}
]
},
{
"info": {
"name": "Sites WAN Usages",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteWanUsage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_usages/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "peer_mac",
"value": "",
"type": "query",
"description": "Peer MAC address"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID for the device"
},
{
"name": "peer_port_id",
"value": "",
"type": "query",
"description": "Peer Port ID for the device"
},
{
"name": "policy",
"value": "",
"type": "query",
"description": "Policy for the wan path"
},
{
"name": "tenant",
"value": "",
"type": "query",
"description": "Tenant network in which the packet is sent"
},
{
"name": "path_type",
"value": "",
"type": "query",
"description": "path_type of the port"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count Site WAN Usages"
},
{
"info": {
"name": "searchSiteWanUsage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wan_usages/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "MAC address"
},
{
"name": "peer_mac",
"value": "",
"type": "query",
"description": "Peer MAC address"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port ID for the device"
},
{
"name": "peer_port_id",
"value": "",
"type": "query",
"description": "Peer Port ID for the device"
},
{
"name": "policy",
"value": "",
"type": "query",
"description": "Policy for the wan path"
},
{
"name": "tenant",
"value": "",
"type": "query",
"description": "Tenant network in which the packet is sent"
},
{
"name": "path_type",
"value": "",
"type": "query",
"description": "path_type of the port"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
}
]
},
"docs": "Search Site WAN Usages"
}
]
},
{
"info": {
"name": "Sites Webhooks",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWebhooks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Webhooks"
},
{
"info": {
"name": "createSiteWebhook",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Webhook defines a webhook, modeled after [github\\u2019s model](https://developer.github.com/webhooks/).\n\n\nThere is two types of webhooks:\n* webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114)) \n* raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b))\n\n\n##### Webhooks\nWebhooks can be co"
},
{
"info": {
"name": "getSiteWebhook",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Webhook Details"
},
{
"info": {
"name": "updateSiteWebhook",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Webhook"
},
{
"info": {
"name": "deleteSiteWebhook",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Webhook"
},
{
"info": {
"name": "countSiteWebhooksDeliveries",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/events/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
},
{
"name": "error",
"value": "",
"type": "query"
},
{
"name": "status_code",
"value": "",
"type": "query"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Webhook delivery status"
},
{
"name": "topic",
"value": "",
"type": "query",
"description": "Webhook topic"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping"
},
{
"info": {
"name": "searchSiteWebhooksDeliveries",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/events/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
},
{
"name": "error",
"value": "",
"type": "query"
},
{
"name": "status_code",
"value": "",
"type": "query"
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Webhook delivery status"
},
{
"name": "topic",
"value": "",
"type": "query",
"description": "Webhook topic"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping"
},
{
"info": {
"name": "pingSiteWebhook",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/ping",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "webhook_id",
"value": "",
"type": "path"
}
]
},
"docs": "Send a Ping event to the webhook"
}
]
},
{
"info": {
"name": "Sites Clients - Wired",
"type": "folder"
},
"items": [
{
"info": {
"name": "countSiteWiredClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wired_clients/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "",
"type": "query"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Client mac"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "Device mac"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port id"
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "VLAN"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Clients"
},
{
"info": {
"name": "searchSiteWiredClients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wired_clients/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "device_mac",
"value": "",
"type": "query",
"description": "Device mac"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "Client mac"
},
{
"name": "ip",
"value": "",
"type": "query",
"description": "Client ip"
},
{
"name": "port_id",
"value": "",
"type": "query",
"description": "Port id"
},
{
"name": "source",
"value": "",
"type": "query",
"description": "source from where the client was learned (lldp, mac)"
},
{
"name": "vlan",
"value": "",
"type": "query",
"description": "VLAN"
},
{
"name": "manufacture",
"value": "",
"type": "query",
"description": "Manufacture"
},
{
"name": "text",
"value": "",
"type": "query",
"description": "Single entry of hostname/mac"
},
{
"name": "nacrule_id",
"value": "",
"type": "query",
"description": "nacrule_id"
},
{
"name": "dhcp_hostname",
"value": "",
"type": "query",
"description": "DHCP Hostname"
},
{
"name": "dhcp_fqdn",
"value": "",
"type": "query",
"description": "DHCP FQDN"
},
{
"name": "dhcp_client_identifier",
"value": "",
"type": "query",
"description": "DHCP Client Identifier"
},
{
"name": "dhcp_vendor_class_identifier",
"value": "",
"type": "query",
"description": "DHCP Vendor Class Identifier"
},
{
"name": "dhcp_request_params",
"value": "",
"type": "query",
"description": "DHCP Request Parameters"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Wired Clients"
}
]
},
{
"info": {
"name": "Sites Wlans",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWlans",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site WLANs"
},
{
"info": {
"name": "createSiteWlan",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site WLAN"
},
{
"info": {
"name": "listSiteWlansDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "resolve",
"value": "",
"type": "query",
"description": "Whether to resolve SITE_VARS"
},
{
"name": "wlan_id",
"value": "",
"type": "query",
"description": "Filter by WLAN ID"
}
]
},
"docs": "Get the list of derived Wlans for a Site"
},
{
"info": {
"name": "getSiteWlan",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site WLAN"
},
{
"info": {
"name": "updateSiteWlan",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site WLAN"
},
{
"info": {
"name": "deleteSiteWlan",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site WLAN"
},
{
"info": {
"name": "uploadSiteWlanPortalImage",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id/portal_image",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "multipart-form",
"data": []
}
},
"docs": "WLAN Portal Image Upload"
},
{
"info": {
"name": "deleteSiteWlanPortalImage",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id/portal_image",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site WLAN Portal Image"
},
{
"info": {
"name": "updateSiteWlanPortalTemplate",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id/portal_template",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wlan_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Portal Template\n\n#### Sponsor Email Template\nSponsor Email Template supports following template variables:\n\n| **Name** | **Description** |\n| --- | --- |\n| approve_url | Renders URL to approve the request; optionally &minutes=N query param can be appended to change the Authorization period of the guest, where N is a valid integer denoting number of minutes a guest remains authorized |\n| deny_url | Renders URL to reject the request |\n| guest_email | Renders Email ID of the guest |\n| guest"
}
]
},
{
"info": {
"name": "Sites WxRules",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWxRules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site WxLan Rules"
},
{
"info": {
"name": "createSiteWxRule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site WxLan Rule"
},
{
"info": {
"name": "ListSiteWxRulesDerived",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules/derived",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the list of derived WxLan Rule for a site"
},
{
"info": {
"name": "getSiteWxRule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules/:wxrule_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxrule_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site WxLan Rule Details"
},
{
"info": {
"name": "updateSiteWxRule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules/:wxrule_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxrule_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site WxLan Rule"
},
{
"info": {
"name": "deleteSiteWxRule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxrules/:wxrule_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxrule_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site WxLan Rule"
}
]
},
{
"info": {
"name": "Sites WxTags",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWxTags",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site WxTags"
},
{
"info": {
"name": "createSiteWxTag",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site WxTag"
},
{
"info": {
"name": "getSiteApplicationList",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags/apps",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Application List"
},
{
"info": {
"name": "getSiteWxTag",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags/:wxtag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtag_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site WxTag Details"
},
{
"info": {
"name": "updateSiteWxTag",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags/:wxtag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtag_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site WxTag"
},
{
"info": {
"name": "deleteSiteWxTag",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtags/:wxtag_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtag_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site WxTag"
}
]
},
{
"info": {
"name": "Sites WxTunnels",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteWxTunnels",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtunnels",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site WxLan Tunnels"
},
{
"info": {
"name": "createSiteWxTunnel",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtunnels",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site WxLan Tunnel"
},
{
"info": {
"name": "getSiteWxTunnel",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtunnels/:wxtunnel_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtunnel_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site WxLan tunnel Details"
},
{
"info": {
"name": "updateSiteWxTunnel",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtunnels/:wxtunnel_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtunnel_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site WxLan Tunnel"
},
{
"info": {
"name": "deleteSiteWxTunnel",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/wxtunnels/:wxtunnel_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "wxtunnel_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site WxLan Tunnel"
}
]
},
{
"info": {
"name": "Sites Zones",
"type": "folder"
},
"items": [
{
"info": {
"name": "listSiteZones",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/zones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
}
]
},
"docs": "Get List of Site Zones"
},
{
"info": {
"name": "createSiteZone",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.mist.com/api/v1/sites/:site_id/zones",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create Site Zone"
},
{
"info": {
"name": "getSiteZone",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/zones/:zone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Get Site Zone Details"
},
{
"info": {
"name": "updateSiteZone",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.mist.com/api/v1/sites/:site_id/zones/:zone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Site Zone"
},
{
"info": {
"name": "deleteSiteZone",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.mist.com/api/v1/sites/:site_id/zones/:zone_id",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_id",
"value": "",
"type": "path"
}
]
},
"docs": "Delete Site Zone"
},
{
"info": {
"name": "countSiteZoneSessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/:zone_type/count",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_type",
"value": "",
"type": "path"
},
{
"name": "distinct",
"value": "scope_id",
"type": "query"
},
{
"name": "user_type",
"value": "",
"type": "query",
"description": "User type"
},
{
"name": "user",
"value": "",
"type": "query",
"description": "Client MAC / Asset MAC / SDK UUID"
},
{
"name": "scope_id",
"value": "",
"type": "query",
"description": "If `scope`==`map`/`zone`/`rssizone`, the scope id"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Scope"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "limit",
"value": "",
"type": "query"
}
]
},
"docs": "Count by Distinct Attributes of Site Zone Sessions"
},
{
"info": {
"name": "searchSiteZoneSessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.mist.com/api/v1/sites/:site_id/:zone_type/visits/search",
"params": [
{
"name": "site_id",
"value": "",
"type": "path"
},
{
"name": "zone_type",
"value": "",
"type": "path"
},
{
"name": "user_type",
"value": "",
"type": "query",
"description": "User type, client (default) / sdkclient / asset"
},
{
"name": "user",
"value": "",
"type": "query",
"description": "Client MAC / Asset MAC / SDK UUID"
},
{
"name": "scope_id",
"value": "",
"type": "query",
"description": "If `scope`==`map`/`zone`/`rssizone`, the scope id"
},
{
"name": "scope",
"value": "",
"type": "query",
"description": "Scope"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")"
},
{
"name": "end",
"value": "",
"type": "query",
"description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")"
},
{
"name": "duration",
"value": "",
"type": "query",
"description": "Duration like 7d, 2w"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "On which field the list should be sorted, -prefix represents DESC order"
},
{
"name": "search_after",
"value": "",
"type": "query",
"description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
}
]
},
"docs": "Search Zone Sessions"
}
]
}
],
"bundled": true
}