openapi-directory/api/mist.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.1","servers":[{"description":"Mist Global 01","url":"https://api.mist.com"},{"description":"Mist Global 02","url":"https://api.gc1.mist.com"},{"description":"Mist Global 03","url":"https://api.ac2.mist.com"},{"description":"Mist Global 04","url":"https://api.gc2.mist.com"},{"description":"Mist Europe 01","url":"https://api.eu.mist.com"}],"info":{"contact":{"email":"tmunzer@juniper.net","name":"Thomas Munzer"},"description":"> Version: **0.37.7**\n>\n> Date: **April 21, 2023**\n\n---\n\n#### Available Documentation\n* [Postman](https://documenter.getpostman.com/view/224925/SzYgQufe)\n* [Open API](https://doc.mist-lab.fr/)\n\n---\n\n#### Useful links\n* [Mist Homepage](https://www.mist.com)\n* [Mist Documentation](https://www.mist.com/documentation)\n* [Official API Documentation](https://api.mist.com/api/v1/docs/Home) (Mist account required)\n* [Mist Blog](https://www.mist.com/news/?md_post_type=post)\n* [Mist Updates](https://www.mist.com/documentation/category/product-updates/)","license":{"name":"MIT","url":"https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE"},"title":"Mist API","version":"0.37.7","x-apisguru-categories":["enterprise"],"x-logo":{"altText":"Juniper-MistAI","backgroundColor":"#FFFFFF","url":"https://cdn.mist.com/wp-content/uploads/logo.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/tmunzer/mist_openapi/main/mist.openapi.yml","version":"3.0"}],"x-providerName":"mist.com"},"security":[{"apiToken":[]},{"basicAuth":[]}],"tags":[{"name":"Login"},{"description":"A Mist account can be linked to OAuth2 providers:\\n1. First, login with your Mist account\\n2. Obtain the Authorization URL for Linking 1. in JSON response, more usable for developers. Simply don\\'t specify the forward parameter when obtaining the authorization URL 2. or as GET parameter, for UI where the user flow can be continued. Specify the landing page/url of your choice 3. Obtain the authorizaiton code by clicking / going through Authorization URL Link Mist Account against OAuth2 Provider by using the authorization code","name":"Login With OAuth2"},{"description":"Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.\n\nNotes:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens (/api/v1/docs/Org#api-token) which can have privileges of a specific Org/Site for more information.","name":"API Token"},{"description":"In a typical enterprise, a separate group of people, Installers, are responsible for install new devices. May it be a new installation (e.g. new stores), a replacement installation (e.g. replacing Cisco APs with Mist APs), or addition (e.g. adding new APs for better coverage). Instead of granting them Admin/Write privilege, it's more desirable to grant them minimum privileges to do the initial provisioning so they cannot read sensible information (e.g. PSK of a WLAN), or change configs of running APs.\nAt a high level, Installer APs try to achieve the following:\n1. identifying a device by MAC (that’s what they see)\n2. they can only touch configurations of the devices they’re installing\n3. allow the following configurations: * name * site assignment * device  profile assignment * map and location (x/y) assignment * claim (if not already in the inventory) * replace existing device with the device being installed\n\n* Grace Period *\nGrace period provides a dynamic way to limit what devices / sites   installer can work on. Generally installers work on recent deployments -  bringing up new sites, add newly claimed devices to new / existing sites. They  make mistakes, too, and may need to further tweak some of the parameters.   Default grace period is 7 days and can be set from 1 day to 365 days.","name":"Installer"},{"name":"Admin"},{"name":"Mobile"},{"description":"MSP (Managed Service Provider) contains multiple Organizations.","name":"Msps"},{"name":"Msps Admins"},{"name":"Msps Inventory"},{"name":"Msps Invites"},{"name":"Msps Logo"},{"name":"Msps Logs"},{"name":"Msps Licenses"},{"name":"Msps Org Groups"},{"name":"Msps Orgs"},{"name":"Msps Search"},{"name":"Msps SLEs"},{"name":"Msps SSO Roles"},{"name":"Msps SSO"},{"name":"Msps Stats"},{"name":"Msps Tickets"},{"description":"An organization usually represents a customer - which has inventories, licenses. An Organization can contain multiple sites. A site usually represents a deployment at the same location (a campus, an office).","name":"Orgs"},{"name":"Orgs 128T"},{"name":"Orgs Admins"},{"description":"Alarms are triggered based on certain events. Alarms could be configured using an Alarm Template.","name":"Orgs Alarms"},{"description":"An Alarm Template is a set of Alarm Rules that could be applied to one or more sites (while each site can only pick one Alarm Template), or to the whole org.","name":"Orgs Alarm Templates"},{"name":"Orgs AP Templates"},{"name":"Orgs API Tokens"},{"name":"Orgs Assets"},{"name":"Orgs Asset Filters"},{"name":"Orgs Calls"},{"name":"Orgs Cert"},{"name":"Orgs Clients"},{"name":"Orgs CRL"},{"description":"While Templates / RF Templates / Network Templates / Gateway Templates provides powerful ways to control how a Device\\'s configuration is derived for a Site. There are cases where you\\'d like another level of control at the Org Level.\nA Device Profile contains a subset of Device\\'s configurations you\\'d like a device to have. It will be merged at runtime when we\\'re provisioning an AP.","name":"Orgs Device Profiles"},{"name":"Orgs Devices"},{"description":"EVPN allows an alternative but more efficient LAN architecture utilizing VxLAN / MP-BGP - separating control plane (MAC / IP Learning) from forwarding plane.\nIn our implementation, following the steps to deploy EVPN topologies in a Site","name":"Orgs EVPN Topologies"},{"description":"API Call for 3rd party devices","name":"Orgs Devices Others"},{"name":"Orgs Devices Stats"},{"name":"Orgs Devices Upgrades"},{"description":"In Zscaler UI \n 1. add Partner Integration at https://admin.zscalerbeta.net/#administration/partner-integration \n 2. Add Partner Administrator Role at https://admin.zscalerbeta.net/#administration/role-management - Name: Mist - Access: Full \n 3. add Partner Admin at https://admin.zscalerbeta.net/#administration/admin-management with - Login ID: john - email: john@abc.com \n 4. Find the cloud name for ZIA https://help.zscaler.com/zia/what-my-cloud-name-zia\n","name":"Orgs Devices Zscaler"},{"description":"Gateway Template is applied to a site for gateway(s) in a site.","name":"Orgs Gateway Templates"},{"name":"Orgs Guests"},{"name":"Orgs Inventory"},{"name":"Orgs Invites"},{"description":"Juniper Support Insight is a free service provided to all Mist customers. You can adopt your devices via a few lines CLI comands. Allowing you to \n* get some basic information about the adopted devices \n* web shell into device (write privilege required) \n* upgrade (write privilege required)","name":"Orgs JSI"},{"name":"Orgs Licenses"},{"name":"Orgs Logs"},{"name":"Orgs Marvis"},{"name":"Orgs Maps"},{"name":"Orgs MxClusters"},{"name":"Orgs MxEdges"},{"name":"Orgs MxTunnels"},{"name":"Orgs NAC Tags"},{"name":"Orgs NAC Rules"},{"description":"Network template is intended to be applied to a Site. It works like a blueprint of the network of the site.\nAll Site Settings can go into Network Templates. See Site:Site Setting for schema\nMoreover, this can be further be overwriten by individual Site Setting","name":"Orgs Network Templates"},{"name":"Orgs Networks"},{"name":"Orgs OAuth"},{"name":"Orgs Premium Analytics"},{"name":"Orgs Psks"},{"description":"PSK Self-Service Portals are for \n  1. **WIFI users** who want to connect to a WLAN with personal PSK, they’re told to connect to a URL where they can login (likely through company’s SSO) and get the WIFI Name / Passphrase - required input fields name, email so we can generate PSK \n  2. **PSK Admins** (they don’t have access to normal Network Admin Portal)\nWhen a PSK portal is created, an unique URL will be generated (e.g. https://psk.mist.com/xxxxxx)","name":"Orgs Psk Portals"},{"name":"Orgs RF Templates"},{"name":"Orgs SDK Clients"},{"name":"Orgs SDK Invites"},{"name":"Orgs SDK Templates"},{"description":"Security Policy is designed to audit / catch discripancies between “what’s intended to be running” versus “what’s actually running” in a network. Many big organizations have separated Security and IT team (for good reasons). Each site can be assigned a security policy. Whenever an AP is provisioned, the configuration will be checked against the security policy. Any violations will be flagged in [Device Config History](#tag/Sites-Devices/operation/searchSiteDeviceConfigHistory) where you can search for the when and where the violation occurs.","name":"Orgs SecPolicies"},{"name":"Orgs Services"},{"name":"Orgs Service Policies"},{"name":"Orgs Setting"},{"name":"Orgs Sitegroups"},{"name":"Orgs Sites"},{"description":"Site template is intended to be applied to a Site. The items in site setting which should be shared for all device types.","name":"Orgs Site Templates"},{"name":"Orgs SLEs"},{"name":"Orgs SSO Roles"},{"name":"Orgs SSO"},{"name":"Orgs Stats"},{"name":"Orgs Stats Tunnels"},{"name":"Orgs Subscriptions"},{"name":"Orgs Templates"},{"name":"Orgs Tickets"},{"name":"Orgs Troubleshoot"},{"name":"Orgs VPNs"},{"name":"Orgs Webhooks"},{"name":"Orgs Wlans"},{"name":"Orgs WxRules"},{"name":"Orgs WxTags"},{"name":"Orgs WxTunnels"},{"description":"A site represents a project, a deployment. For MSP, it can be as small as a coffee shop or a five-star 600-room hotel. A site contains a set of Maps, Wlans, Policies, Zones.","name":"Sites"},{"name":"Sites Alarms"},{"description":"Applications contains a list of applications users are interested in monitoring / routing / policying","name":"Sites Applications"},{"name":"Sites Anomaly"},{"name":"Sites Asset Filters"},{"name":"Sites Assets"},{"name":"Sites Beacons"},{"name":"Sites Calls"},{"name":"Sites Clients"},{"description":"Mist provides many ways (device-type specific template, site template, device profile, per-device) to configure devices for different kind of scenarios.\nThe precedence goes from most specific to least specific\nDevice > Device Profile > RFTemplate (for AP only) > DeviceType-specific Template > Site Template > Site Setting","name":"Sites Devices"},{"name":"Sites Devices APs"},{"description":"API Call for 3rd party devices","name":"Sites Devices Others"},{"name":"Sites Devices Switches"},{"name":"Sites Devices Switches Virtual Chassis"},{"name":"Sites Devices WAN Edges"},{"name":"Sites Devices WAN Edges HA"},{"name":"Sites Devices Stats"},{"name":"Sites Devices Upgrades"},{"name":"Sites Devices Utilities"},{"name":"Sites Events"},{"description":"EVPN allows an alternative but more efficient LAN architecture utilizing VxLAN / MP-BGP - separating control plane (MAC / IP Learning) from forwarding plane.\nIn our implementation, following the steps to deploy EVPN topologies in a Site ","name":"Sites EVPN Topologies"},{"name":"Sites Guests"},{"name":"Sites Insights"},{"name":"Sites Licenses"},{"name":"Sites Location"},{"name":"Sites Maps"},{"name":"Sites Maps Auto-orientation"},{"name":"Sites Maps Auto-placement"},{"name":"Sites MxEdges"},{"name":"Sites MxTunnels"},{"name":"Sites Pcaps"},{"name":"Sites Psks"},{"name":"Sites Rfdiags"},{"name":"Sites Rogues"},{"name":"Sites RRM"},{"name":"Sites Rssizones"},{"name":"Sites Setting"},{"name":"Sites Skyatp"},{"name":"Sites SLEs"},{"name":"Sites Stats"},{"name":"Sites Subscriptions"},{"name":"Sites Synthetic Tests"},{"name":"Sites UI Settings"},{"name":"Sites vBeacons"},{"name":"Sites Webhooks"},{"name":"Sites Wired Clients"},{"name":"Sites Wlans"},{"name":"Sites WxRules"},{"name":"Sites WxTags"},{"name":"Sites WxTunnels"},{"name":"Sites Zones"},{"name":"Constants"},{"name":"Self"},{"name":"Account"},{"name":"Webhook Samples"}],"paths":{"/api/v1/const/alarm_defs":{"get":{"description":"Get List of brief definitions of all the supported alarm types.  The example field contains an example payload as you would recieve in the alarm webhook output.","operationId":"listAlarmDefinitions","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"display":"Device offline","example":{"aps":["d420b02000fa"],"count":1,"group":"infrastructure","hostnames":["Vendor_AP2"],"id":"f70c308f-7007-4866-9ecd-0d01842979ea","last_seen":1629753888,"org_id":"09dac91f-6e73-4100-89f7-698e0fafbb1b","severity":"warn","site_id":"dcfb31a1-d615-4361-8c95-b9dde05aa704","timestamp":1629753888,"type":"device_down"},"fields":["aps","hostnames"],"group":"infrastructure","key":"device_down","severity":"warn"}]}},"schema":{"items":{"properties":{"display":{"description":"Description of the alarm type","type":"string"},"fields":{"description":"List of fields available in an alarm details payload (in REST APIs & Webhooks); e.g. `aps`, `switches`, `gateways`, `hostnames`, `ssids`, `bssids`","items":{"type":"string"},"type":"array"},"group":{"description":"Group to which the alarm belongs","type":"string"},"key":{"description":"Key name of an alarm type","type":"string"},"marvis_suggestion_category":{"description":"Marvis defined category to which the alarm belongs","type":"string"},"severity":{"description":"Severity of the alarm","type":"string"}},"required":["key","display","group","severity","fields"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listAlarmDefinitions","tags":["Constants"]}},"/api/v1/const/ap_channels":{"get":{"description":"Get List of List of Available channels per country code","operationId":"listApChannels","parameters":[{"$ref":"#/components/parameters/country_code"}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"band24_channels":{"20":[1,2,3,4,5,6,7,8,9,10,11],"40":[1,2,3,4,5,6,7,8,9,10,11]},"band24_enabled":true,"band5_channels":{"20":[36,40,44,48,52,56,60,64,100,104,108,112,116,132,136,140,149,153,157,161,165],"40":[36,40,44,48,52,56,60,64,100,104,108,112,132,136,149,153,157,161],"80":[36,40,44,48,52,56,60,64,100,104,108,112,132,136,149,153,157,161],"dfs":[52,56,60,64,100,104,108,112,116,132,136,140]},"band5_enabled":true,"code":840,"dfs_ok":true,"key":"US","name":"United States"}}},"schema":{"properties":{"band24_channels":{"additionalProperties":{"items":{"type":"integer"},"type":"array"},"description":"The property key is the channel width","required":["20","40"],"type":"object"},"band24_enabled":{"type":"boolean"},"band5_channels":{"additionalProperties":{"items":{"type":"integer"},"type":"array"},"description":"The property key is the channel width","type":"object"},"band5_enabled":{"type":"boolean"},"code":{"type":"integer"},"dfs_ok":{"type":"boolean"},"key":{"type":"string"},"name":{"type":"string"}},"required":["key","name","code","band24_enabled","band24_channels","band5_enabled","dfs_ok","band5_channels"],"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listApChannels","tags":["Constants"]}},"/api/v1/const/ap_led_status":{"get":{"description":"Get List of AP LED definition","operationId":"listApLedDefinition","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"code":"02","description":"Has no link (Seen using power injectors, but not connected to a switch)","key":"NO_ETHERNET_LINK","name":"No ethernet link"}]}},"schema":{"items":{"properties":{"code":{"type":"string"},"description":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"}},"required":["code","key","name","description"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listApLedDefinition","tags":["Constants"]}},"/api/v1/const/applications":{"get":{"description":"Get List of a list of applications that Juniper-Mist APs recognize","operationId":"listApplications","responses":{"200":{"$ref":"#/components/responses/ConstApplications"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listApplications","tags":["Constants"]}},"/api/v1/const/call_events":{"get":{"description":"Get List of Call Event Definitions","operationId":"listCallEventsDefinitions","responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":[{"description":"Client joined the call","display":"Client joined the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENTS_JOINED_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_JOINED_CALL"},{"description":"Client got abruptly disconnected from the call","display":"Client disconnected abruptly from the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","reason":"Network connection error.","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENT_DISCONNECTED_FROM_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_DISCONNECTED_FROM_CALL"},{"description":"Client left the call","display":"Client left the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENT_LEFT_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_LEFT_CALL"},{"description":"Zoom/Teams CPU usage is high","display":"High CPU Observed","example":{"app":"zoom","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","timestamp":1674777600,"type":"HIGH_CPU_OBSERVED"},"key":"HIGH_CPU_OBSERVED"}]}},"schema":{"items":{"properties":{"description":{"type":"string"},"display":{"type":"string"},"example":{"properties":{"app":{"type":"string"},"meeting_id":{"type":"string"},"org_id":{"type":"string"},"site_id":{"type":"string"},"timestamp":{"type":"integer"},"type":{"type":"string"},"wcid":{"type":"string"}},"type":"object"},"key":{"type":"string"}},"type":"object"},"type":"array","x-examples":{"Example 1":[{"description":"Client joined the call","display":"Client joined the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENTS_JOINED_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_JOINED_CALL"},{"description":"Client got abruptly disconnected from the call","display":"Client disconnected abruptly from the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","reason":"Network connection error.","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENT_DISCONNECTED_FROM_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_DISCONNECTED_FROM_CALL"},{"description":"Client left the call","display":"Client left the call","example":{"app":"zoom","meeting_id":"87609329850","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"1916d52a-4a90-11e5-8b45-1258369c38a9","timestamp":1674777600,"type":"CLIENT_LEFT_CALL","wcid":"82c70a73-e2e1-42f9-6da0-97db44b7b9ad"},"key":"CLIENT_LEFT_CALL"},{"description":"Zoom/Teams CPU usage is high","display":"High CPU Observed","example":{"app":"zoom","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","timestamp":1674777600,"type":"HIGH_CPU_OBSERVED"},"key":"HIGH_CPU_OBSERVED"}]}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listCallEventsDefinitions","tags":["Constants"]}},"/api/v1/const/client_events":{"get":{"description":"Get List of List of available Client Events","operationId":"listClientEventsDefinitions","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"display":"DHCP Success","key":"CLIENT_IP_ASSIGNED"}]}},"schema":{"items":{"properties":{"display":{"type":"string"},"key":{"type":"string"}},"required":["key","display"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listClientEventsDefinitions","tags":["Constants"]}},"/api/v1/const/countries":{"get":{"description":"Get List of List of available Country Codes","operationId":"listCountryCodes","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"alpha2":"US","certified":true,"name":"United States","numeric":840},{"alpha2":"JP","certified":true,"name":"Japan","numeric":392}]}},"schema":{"items":{"properties":{"alpha2":{"type":"string"},"certified":{"type":"boolean"},"name":{"type":"string"},"numeric":{"type":"number"}},"required":["alpha2","numeric","name","certified"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listCountryCodes","tags":["Constants"]}},"/api/v1/const/default_gateway_config":{"get":{"description":"Generate Default Gateway Config","operationId":"getGatawayDefaultConfig","parameters":[{"description":"model the default gateway config is intended (as the default LAN/WAN port can differ)","in":"query","name":"model","schema":{"type":"string"}},{"description":"whether the config is intended for HA","in":"query","name":"ha","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"dhcpd_config":{"lan":{"ip_end":"192.168.1.254","ip_start":"192.168.1.2"}},"ip_configs":{"lan":{"ip":"192.168.1.1","type":"static"}},"networks":{"lan":{"name":"lan","subnet":"192.168.1.0/24","vlan_id":1}},"path_preferences":{"wan":{"paths":[{"name":"wan","type":"wan"}]}},"port_config":{"cl-1/0/0":{"ip_config":{"type":"dhcp"},"name":"lte","usage":"wan","wan_type":"lte"},"ge-0/0/0,ge-0/0/7":{"ip_config":{"type":"dhcp"},"name":"wan","usage":"wan"},"ge-0/0/1-6":{"port_network":"lan","usage":"lan"}},"service_policies":[{"action":"allow","name":"Internet","path_preference":"wan","services":["any"],"tenants":["lan"]}]}}},"schema":{"additionalProperties":true,"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"getGatawayDefaultConfig","tags":["Constants"]}},"/api/v1/const/device_events":{"get":{"description":"Get list of available Device Events","operationId":"listDeviceEventsDefinitions","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"description":"AP was assigned to a site","display":"AP Assigned","example":{"ap":"5c5b35000001","audit_id":"e9a88814-fa81-5bdc-34b0-84e8735420e5","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","timestamp":1552408871,"type":"AP_ASSIGNED"},"key":"AP_ASSIGNED"}]}},"schema":{"items":{"properties":{"description":{"minLength":1,"type":"string"},"display":{"minLength":1,"type":"string"},"example":{"type":"object"},"key":{"minLength":1,"type":"string"}},"required":["key"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true,"x-examples":{"example-1":[{"description":"AP was assigned to a site","display":"AP Assigned","example":{"ap":"5c5b35000001","audit_id":"e9a88814-fa81-5bdc-34b0-84e8735420e5","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","timestamp":1552408871,"type":"AP_ASSIGNED"},"key":"AP_ASSIGNED"}]}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listDeviceEventsDefinitions","tags":["Constants"]}},"/api/v1/const/device_models":{"get":{"description":"Get list of AP device models for the Mist Site","operationId":"listDeviceModels","responses":{"200":{"$ref":"#/components/responses/ConstDeviceModels"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listDeviceModels","tags":["Constants"]}},"/api/v1/const/insight_metrics":{"get":{"description":"Get List of Available Insight Metrics","operationId":"listSiteAvailableInsightMetrics","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"bytes":{"description":"aggregated bytes over time","example":[185,197,250],"intervals":{"10m":{"interval":600,"max_age":86400},"1h":{"interval":3600,"max_age":1209600}},"report_durations":{"1d":{"duration":86400,"interval":3600},"1w":{"duration":604800,"interval":3600}},"report_scopes":["site","org"],"scopes":["site","ap","client"],"type":"timeseries","unit":"byte"},"num_clients":{"description":"number of client over time","example":[18,null,15],"intervals":{"10m":{"interval":600,"max_age":86400},"1h":{"interval":3600,"max_age":1209600}},"report_durations":{"1d":{"duration":86400,"interval":3600},"1w":{"duration":604800,"interval":3600}},"report_scopes":["site","org"],"scopes":["site","ap","device"],"type":"timeseries","unit":""}}}},"schema":{"additionalProperties":{"properties":{"description":{"type":"string"},"example":{"items":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"integer"},{"nullable":true,"type":"number"},{"nullable":true,"type":"string"}]},"type":"array"},"intervals":{"additionalProperties":{"properties":{"interval":{"type":"number"},"max_age":{"type":"number"}},"type":"object"},"type":"object"},"report_intervals":{"additionalProperties":{"properties":{"interval":{"type":"number"}},"type":"object"},"type":"object"},"report_scopes":{"items":{"type":"string"},"type":"array"},"scopes":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"},"unit":{"type":"string"}},"type":"object"},"description":"The property key is the metric name","type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listSiteAvailableInsightMetrics","tags":["Constants"]}},"/api/v1/const/languages":{"get":{"description":"Get List of Languages","operationId":"listSiteLanguages","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"display":"English (US)","display_native":"English (US)","key":"en-US"},{"display":"Chinese Traditional (Taiwan)","display_native":"中文（台灣）","key":"zh-TW"}]}},"schema":{"items":{"properties":{"display":{"type":"string"},"display_native":{"type":"string"},"key":{"type":"string"}},"required":["display","display_native","key"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listSiteLanguages","tags":["Constants"]}},"/api/v1/const/mxedge_events":{"get":{"description":"Get List of available MX Edge Events","operationId":"listMxEdgeEventsDefinitions","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"description":"Config change on ME was triggered as a result of change made by user","display":"ME Config changed by user","example":{"audit_id":"e9a88814-fa81-5bdc-34b0-84e8735420e5","mxcluster_id":"ed4665ed-c9ad-4835-8ca5-dda642765ad3","mxedge_id":"387804a7-3474-85ce-15a2-f9a9684c9c90","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","service":"mxagent","site_id":"4ac1dcf4-9d8b-7211-65c4-057819f0862b","timestamp":1552408871,"type":"ME_CONFIG_CHANGED_BY_USER"},"key":"ME_CONFIG_CHANGED_BY_USER"}]}},"schema":{"items":{"properties":{"description":{"type":"string"},"display":{"type":"string"},"example":{"properties":{},"type":"object"},"key":{"type":"string"}},"type":"object"},"type":"array","x-examples":{"example-1":[{"description":"Config change on ME was triggered as a result of change made by user","display":"ME Config changed by user","example":{},"key":"ME_CONFIG_CHANGED_BY_USER"}]}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listMxEdgeEventsDefinitions","tags":["Constants"]}},"/api/v1/const/mxedge_models":{"get":{"description":"Get List of available Mx Edge models","operationId":"listMxEdgeModels","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"custom_ports":true,"display":"string","model":"string","ports":{"0":{"display":"string","speed":0},"1":{"display":"string","speed":0},"2":{"display":"string","speed":0},"3":{"display":"string","speed":0}}}]}},"schema":{"items":{"properties":{"custom_ports":{"type":"boolean"},"display":{"type":"string"},"model":{"type":"string"},"ports":{"properties":{"0":{"properties":{"display":{"type":"string"},"speed":{"type":"integer"}},"type":"object"},"1":{"properties":{"display":{"type":"string"},"speed":{"type":"integer"}},"type":"object"},"2":{"properties":{"display":{"type":"string"},"speed":{"type":"integer"}},"type":"object"},"3":{"properties":{"display":{"type":"string"},"speed":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"},"type":"array","x-examples":{"example-1":[{"display":"X1","model":"ME-100","ports":{"0":{"display":"ge0","speed":1000},"1":{"display":"ge1","speed":1000}}},{"display":"X1","model":"ME-X1","ports":{"0":{"display":"ge0","speed":1000},"1":{"display":"ge1","speed":1000}}},{"display":"X1-M","model":"ME-X1-M","ports":{"0":{"display":"ge0","speed":1000},"1":{"display":"ge1","speed":1000},"2":{"display":"ge2","speed":1000},"3":{"display":"ge3","speed":1000}}},{"display":"X5","model":"ME-200","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000}}},{"display":"X5","model":"ME-201","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000}}},{"display":"X5","model":"ME-X5","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000}}},{"display":"X5-M","model":"ME-250","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"X5-M","model":"ME-251","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"X5-M","model":"ME-X5-M","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"X10","model":"ME-300","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"X10","model":"ME-301","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"X10","model":"ME-X10","ports":{"0":{"display":"xe0","speed":10000},"1":{"display":"xe1","speed":10000},"2":{"display":"xe2","speed":10000},"3":{"display":"xe3","speed":10000}}},{"display":"VM","model":"ME-VM","ports":{"0":{"display":"ge0","speed":1000},"1":{"display":"ge1","speed":1000}}},{"custom_ports":true,"model":"Custom"}]}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listMxEdgeModels","tags":["Constants"]}},"/api/v1/const/traffic_types":{"get":{"description":"Get List of identified traffic","operationId":"listTrafficTypes","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"dscp":0,"failover_policy":"string","name":"string","traffic_class":"string"}]}},"schema":{"description":"Get Traffic Types Constants","items":{"properties":{"dscp":{"type":"number"},"failover_policy":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"traffic_class":{"minLength":1,"type":"string"}},"required":["name","failover_policy","traffic_class","dscp"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true,"x-examples":{"example-1":[{"dscp":0,"failover_policy":"non-revertible","name":"data_best_effort","traffic_class":"low"}]}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listTrafficTypes","tags":["Constants"]}},"/api/v1/installer/orgs/{org_id}/alarmtemplates":{"get":{"description":"Get List of alarm templates","operationId":"listInstallerAlarmTemplates","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"id":"684dfc5c-fe77-2290-eb1d-ef3d677fe168","name":"AlarmTemplate 1"}]}},"schema":{"items":{"properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listInstallerAlarmTemplates","tags":["Installer"]},"parameters":[{"$ref":"#/components/parameters/org_id"}]},"/api/v1/installer/orgs/{org_id}/deviceprofiles":{"get":{"description":"Get List of Device Profiles","operationId":"listInstallerDeviceProfiles","parameters":[],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"id":"6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9","name":"DeviceProfile 1"}]}},"schema":{"items":{"properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Not found."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Not found. The API endpoint doesn't exist or resource doesn't exist"}},"summary":"listInstallerDeviceProfiles","tags":["Installer"]},"parameters":[{"$ref":"#/components/parameters/org_id"}]},"/api/v1/installer/orgs/{org_id}/devices":{"get":{"description":"Get List of recently claimed devices","operationId":"listInstallerListOfRenctlyClaimedDevices","responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":[{"connected":true,"mac":"5c5b35000018","model":"AP41","serial":"FXLH2015150025"},{"connected":false,"deviceprofile_name":"SJ1","name":"hallway","site_name":"SJ1"},{"connected":true,"height":2.7,"map_id":"845a23bf-bed9-e43c-4c86-6fa474be7ae5","orientation":90,"x":150,"y":300}]}},"schema":{"items":{"properties":{"connected":{"type":"boolean"},"height":{"type":"number"},"map_id":{"format":"uuid","type":"string"},"orientation":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"}},"required":["connected"],"type":"object"},"minItems":1,"type":"array","uniqueItems":true}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"properties":{},"type":"object"}}},"description":"The API endpoint exists but its syntax/payload is incorrect, detail may be given"},"401":{"content":{"application/json":{"examples":{"Unauthorized":{"value":{"detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"Permission Denied":{"value":{"detail":"You do not have permission to perform this action."}}},"schema":{"properties":{"detail":{"type":"string"}},"type":"object"}}},"description":"Permission Denied"},"404":{"content":{"application/json":{"examples":{"Unauthoriz