openapi: 3.2.0 info: title: Mist Constants Definitions API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Constants Definitions description: API Calls to retrieve constant values that can be used in different parts of the configuration paths: /api/v1/const/ap_channels: parameters: [] get: tags: - Constants Definitions summary: listApChannels description: Return supported AP radio channels for the requested country code, based on the regulatory domain used by Mist AP configuration. operationId: listApChannels parameters: - name: country_code in: query description: Country code, in two-character style: form explode: true schema: pattern: ^[a-zA-Z]{2}$ type: string examples: - US responses: '200': description: AP Channels headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/const_ap_channel' - description: Country and regulatory-domain channel capabilities for AP radios examples: - band24_40mhz_allowed: true band24_channels: '20': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 '40': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 band24_enabled: true band5_channels: '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 band5_enabled: true band6_channels: '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 band6_enabled: true certified: true code: 840 dfs_ok: true key: US name: United States uses: US_FCC contentMediaType: application/json examples: Example: value: band24_40mhz_allowed: true band24_channels: '20': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 '40': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 band24_enabled: true band5_channels: '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 band5_enabled: true band6_channels: '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 band6_enabled: true certified: true code: 840 dfs_ok: true key: US name: United States uses: US_FCC application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/const_ap_channel' - description: Country and regulatory-domain channel capabilities for AP radios examples: - band24_40mhz_allowed: true band24_channels: '20': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 '40': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 band24_enabled: true band5_channels: '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 band5_enabled: true band6_channels: '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 band6_enabled: true certified: true code: 840 dfs_ok: true key: US name: United States uses: US_FCC contentMediaType: application/vnd.api+json examples: Example: value: band24_40mhz_allowed: true band24_channels: '20': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 '40': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 band24_enabled: true band5_channels: '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 band5_enabled: true band6_channels: '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 band6_enabled: true certified: true code: 840 dfs_ok: true key: US name: United States uses: US_FCC '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/ap_esl_versions: parameters: [] get: tags: - Constants Definitions summary: listApLEslVersions description: Return Electronic Shelf Label (ESL) firmware versions available per AP model. operationId: listApLEslVersions parameters: [] responses: '200': description: List of Available AP ESL Versions headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_ap_esl_version' description: Supported Electronic Shelf Label versions by AP model examples: - - esl_version: 2.5.1 model: AP34 - esl_version: 2.5.0 model: AP43 contentMediaType: application/json examples: Example: value: - esl_version: 2.5.1 model: AP34 - esl_version: 2.5.0 model: AP43 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_ap_esl_version' description: Supported Electronic Shelf Label versions by AP model examples: - - esl_version: 2.5.1 model: AP34 - esl_version: 2.5.0 model: AP43 contentMediaType: application/vnd.api+json examples: Example: value: - esl_version: 2.5.1 model: AP34 - esl_version: 2.5.0 model: AP43 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/ap_led_status: parameters: [] get: tags: - Constants Definitions summary: listApLedDefinition description: Return AP LED status definitions, including the values used to describe LED behavior and the corresponding `error_code` value. operationId: listApLedDefinition parameters: [] responses: '200': description: List of AP Led Status headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_ap_led' description: AP LED status and trouble-code definitions returned by the constants API examples: - - code: '01' description: LED not working key: LED_FAILURE name: LED Failure contentMediaType: application/json examples: Example: value: - code: '01' description: LED not working key: LED_FAILURE name: LED Failure application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_ap_led' description: AP LED status and trouble-code definitions returned by the constants API examples: - - code: '01' description: LED not working key: LED_FAILURE name: LED Failure contentMediaType: application/vnd.api+json examples: Example: value: - code: '01' description: LED not working key: LED_FAILURE name: LED Failure '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/app_categories: parameters: [] get: tags: - Constants Definitions summary: listAppCategoryDefinitions description: Return supported application categories used for application identification, traffic classification, and policy matching. operationId: listAppCategoryDefinitions parameters: [] responses: '200': description: List of Application Categories Definitions headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_app_category_definition' description: Application category definitions returned by the constants API examples: - - display: Images filters: srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers key: Images - display: Standard includes: - Adult - FileSharing - Games - Images - Malware - NewsAndReference - Recreation - Religion - Security - Sports - Technology - Violence key: Standard contentMediaType: application/json examples: Example: value: - display: Images filters: srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers key: Images - display: Standard includes: - Adult - FileSharing - Games - Images - Malware - NewsAndReference - Recreation - Religion - Security - Sports - Technology - Violence key: Standard application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_app_category_definition' description: Application category definitions returned by the constants API examples: - - display: Images filters: srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers key: Images - display: Standard includes: - Adult - FileSharing - Games - Images - Malware - NewsAndReference - Recreation - Religion - Security - Sports - Technology - Violence key: Standard contentMediaType: application/vnd.api+json examples: Example: value: - display: Images filters: srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers key: Images - display: Standard includes: - Adult - FileSharing - Games - Images - Malware - NewsAndReference - Recreation - Religion - Security - Sports - Technology - Violence key: Standard '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/app_subcategories: parameters: [] get: tags: - Constants Definitions summary: listAppSubCategoryDefinitions description: Return supported application subcategories used for application identification, traffic classification, and policy matching. operationId: listAppSubCategoryDefinitions parameters: [] responses: '200': description: List of Application Sub-categories Definitions headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_app_subcategory_definition' description: Application subcategory definitions returned by the constants API examples: - - display: Office Documents key: Office_Documents traffic_type: data_interactive contentMediaType: application/json examples: Example: value: - display: Office Documents key: Office_Documents traffic_type: data_interactive application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_app_subcategory_definition' description: Application subcategory definitions returned by the constants API examples: - - display: Office Documents key: Office_Documents traffic_type: data_interactive contentMediaType: application/vnd.api+json examples: Example: value: - display: Office Documents key: Office_Documents traffic_type: data_interactive '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/applications: parameters: [] get: tags: - Constants Definitions summary: listApplications description: Return applications recognized by Juniper Mist devices for traffic classification and application analytics. operationId: listApplications parameters: [] responses: '200': description: List of Applications headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_application_definition' description: Application definitions returned by the constants API examples: - - app_id: true app_image_url: '' app_probe: true category: FileSharing group: File Sharing key: dropbox name: Dropbox signature_based: true ssr_app_id: true contentMediaType: application/json examples: Example: value: - app_id: true app_image_url: '' app_probe: true category: FileSharing group: File Sharing key: dropbox name: Dropbox signature_based: true ssr_app_id: true application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_application_definition' description: Application definitions returned by the constants API examples: - - app_id: true app_image_url: '' app_probe: true category: FileSharing group: File Sharing key: dropbox name: Dropbox signature_based: true ssr_app_id: true contentMediaType: application/vnd.api+json examples: Example: value: - app_id: true app_image_url: '' app_probe: true category: FileSharing group: File Sharing key: dropbox name: Dropbox signature_based: true ssr_app_id: true '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/countries: parameters: [] get: tags: - Constants Definitions summary: listCountryCodes description: Return supported country codes for Mist configuration. Set `extend=true` to include additional country codes when available. operationId: listCountryCodes parameters: - name: extend in: query description: Will include more country codes if true style: form explode: true schema: type: boolean default: false responses: '200': description: List of Countries headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_country' description: Country definitions returned by the constants API examples: - - alpha2: FR certified: true name: France numeric: 250 contentMediaType: application/json examples: Example: value: - alpha2: FR certified: true name: France numeric: 250 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_country' description: Country definitions returned by the constants API examples: - - alpha2: FR certified: true name: France numeric: 250 contentMediaType: application/vnd.api+json examples: Example: value: - alpha2: FR certified: true name: France numeric: 250 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/fingerprint_types: parameters: [] get: tags: - Constants Definitions summary: listFingerprintTypes description: Return supported client fingerprint attribute values (`family`, `model`, `mfg`, and `os_type`) that can be used in Mist NAC Rules `matching` conditions. operationId: listFingerprintTypes parameters: [] responses: '200': description: List of Fingerprint Types headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/const_fingerprint_types' - description: Supported client fingerprint values for NAC matching examples: - family: - 2Wire Router - 3Com Switches - ACTi Corporation Network Camera - APC Video Equipment - APC-Schneider UPS - Aastra VoIP - Acer - Actiontec Wireless Router - Aerohive Access Point - Alcatel - Alcatel VoIP - Amazon Echo mfg: - 100fio Networks Technology llc - 10NET COMMUNICATIONS/DCA - 11wave Technonlogy Co.,Ltd - 12Sided Technology, LLC - 1Net Corporation - 1Verge Internet Technology (Beijing) Co., Ltd. model: - 10T Lite - 10T Pro - 10th Gen - 11 Lite - 11 Pro - 11 Pro Max os: - Android - Apple OS - Asha Platform OS contentMediaType: application/json examples: Example: value: family: - 2Wire Router - 3Com Switches - ACTi Corporation Network Camera - APC Video Equipment - APC-Schneider UPS - Aastra VoIP - Acer - Actiontec Wireless Router - Aerohive Access Point - Alcatel - Alcatel VoIP - Amazon Echo mfg: - 100fio Networks Technology llc - 10NET COMMUNICATIONS/DCA - 11wave Technonlogy Co.,Ltd - 12Sided Technology, LLC - 1Net Corporation - 1Verge Internet Technology (Beijing) Co., Ltd. model: - 10T Lite - 10T Pro - 10th Gen - 11 Lite - 11 Pro - 11 Pro Max os: - Android - Apple OS - Asha Platform OS application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/const_fingerprint_types' - description: Supported client fingerprint values for NAC matching examples: - family: - 2Wire Router - 3Com Switches - ACTi Corporation Network Camera - APC Video Equipment - APC-Schneider UPS - Aastra VoIP - Acer - Actiontec Wireless Router - Aerohive Access Point - Alcatel - Alcatel VoIP - Amazon Echo mfg: - 100fio Networks Technology llc - 10NET COMMUNICATIONS/DCA - 11wave Technonlogy Co.,Ltd - 12Sided Technology, LLC - 1Net Corporation - 1Verge Internet Technology (Beijing) Co., Ltd. model: - 10T Lite - 10T Pro - 10th Gen - 11 Lite - 11 Pro - 11 Pro Max os: - Android - Apple OS - Asha Platform OS contentMediaType: application/vnd.api+json examples: Example: value: family: - 2Wire Router - 3Com Switches - ACTi Corporation Network Camera - APC Video Equipment - APC-Schneider UPS - Aastra VoIP - Acer - Actiontec Wireless Router - Aerohive Access Point - Alcatel - Alcatel VoIP - Amazon Echo mfg: - 100fio Networks Technology llc - 10NET COMMUNICATIONS/DCA - 11wave Technonlogy Co.,Ltd - 12Sided Technology, LLC - 1Net Corporation - 1Verge Internet Technology (Beijing) Co., Ltd. model: - 10T Lite - 10T Pro - 10th Gen - 11 Lite - 11 Pro - 11 Pro Max os: - Android - Apple OS - Asha Platform OS '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/gateway_applications: parameters: [] get: tags: - Constants Definitions summary: listGatewayApplications description: Return applications recognized by Mist gateways for traffic classification. operationId: listGatewayApplications parameters: [] responses: '200': description: List of Alarm Definitions headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_gateway_applications_definition' description: Gateway application definitions returned by the constants API examples: - - app_id: true key: 4shared name: 4shared ssr_app_id: true contentMediaType: application/json examples: Example: value: - app_id: true key: 4shared name: 4shared ssr_app_id: true application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_gateway_applications_definition' description: Gateway application definitions returned by the constants API examples: - - app_id: true key: 4shared name: 4shared ssr_app_id: true contentMediaType: application/vnd.api+json examples: Example: value: - app_id: true key: 4shared name: 4shared ssr_app_id: true '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/insight_metrics: parameters: [] get: tags: - Constants Definitions summary: listInsightMetrics description: Return supported insight metric names and metadata used by insight and SLE APIs. operationId: listInsightMetrics parameters: [] responses: '200': description: Insight Metrics Definition headers: {} content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/const_insight_metrics_property' description: Property key is the metric name contentMediaType: application/json application/vnd.api+json: schema: type: object additionalProperties: $ref: '#/components/schemas/const_insight_metrics_property' description: Property key is the metric name contentMediaType: application/vnd.api+json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/languages: parameters: [] get: tags: - Constants Definitions summary: listSiteLanguages description: Return supported language codes for localized Mist configuration and user-facing portals. operationId: listSiteLanguages parameters: [] responses: '200': description: List of Languages headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_language' description: Language options returned by the constants API examples: - - display: English (US) display_native: English (US) key: en-US contentMediaType: application/json examples: Example: value: - display: English (US) display_native: English (US) key: en-US application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_language' description: Language options returned by the constants API examples: - - display: English (US) display_native: English (US) key: en-US contentMediaType: application/vnd.api+json examples: Example: value: - display: English (US) display_native: English (US) key: en-US '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/license_types: parameters: [] get: tags: - Constants Definitions summary: listLicenseTypes description: Return Mist license type definitions used by inventory and subscription APIs. operationId: listLicenseTypes parameters: [] responses: '200': description: List of License Types headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_license_type' description: License type definitions returned by the constants API examples: - - description: Wired Assurance 12 includes: - sub_ex12a - sub_ex12p key: sub_ex12 name: SUB-EX12 contentMediaType: application/json examples: Example: value: - description: Wired Assurance 12 includes: - sub_ex12a - sub_ex12p key: sub_ex12 name: SUB-EX12 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_license_type' description: License type definitions returned by the constants API examples: - - description: Wired Assurance 12 includes: - sub_ex12a - sub_ex12p key: sub_ex12 name: SUB-EX12 contentMediaType: application/vnd.api+json examples: Example: value: - description: Wired Assurance 12 includes: - sub_ex12a - sub_ex12p key: sub_ex12 name: SUB-EX12 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/marvisclient_events: parameters: [] get: tags: - Constants Definitions summary: listMarvisClientEventsDefinitions description: Return Marvis Client event type definitions used by the Marvis Client event search and count APIs. operationId: listMarvisClientEventsDefinitions parameters: [] responses: '200': description: List of Marvis Client event type definitions headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_marvisclient_event' description: Marvis Client event type definitions returned by the constants API examples: - - display: Marvis Client Roamed key: MARVISCLIENT_ROAMED contentMediaType: application/json examples: Example: value: - display: Marvis Client Roamed key: MARVISCLIENT_ROAMED application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_marvisclient_event' description: Marvis Client event type definitions returned by the constants API examples: - - display: Marvis Client Roamed key: MARVISCLIENT_ROAMED contentMediaType: application/vnd.api+json examples: Example: value: - display: Marvis Client Roamed key: MARVISCLIENT_ROAMED '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/marvisclient_versions: parameters: [] get: tags: - Constants Definitions summary: listMarvisClientVersions description: Return available Marvis Client application versions for tracking or managing Marvis Client deployments. operationId: listMarvisClientVersions parameters: [] responses: '200': description: List of Webhook Topics headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_marvis_client_version' description: Marvis Client installer versions returned by the constants API examples: - - label: latest notes: '' os: android url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk version: 1.1.9 - label: rc1 notes: '' os: macos url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg version: 0.100.29 - label: default notes: '' os: windows url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip version: 0.100.26 contentMediaType: application/json examples: Example: value: - label: latest notes: '' os: android url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk version: 1.1.9 - label: rc1 notes: '' os: macos url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg version: 0.100.29 - label: default notes: '' os: windows url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip version: 0.100.26 application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_marvis_client_version' description: Marvis Client installer versions returned by the constants API examples: - - label: latest notes: '' os: android url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk version: 1.1.9 - label: rc1 notes: '' os: macos url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg version: 0.100.29 - label: default notes: '' os: windows url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip version: 0.100.26 contentMediaType: application/vnd.api+json examples: Example: value: - label: latest notes: '' os: android url: https://mobile.mist.com/installers/marvisclient/android/1.1.9/marvisclient-installer.apk version: 1.1.9 - label: rc1 notes: '' os: macos url: https://mobile.mist.com/installers/marvisclient/macos/0.100.29/marvisclient-installer.dmg version: 0.100.29 - label: default notes: '' os: windows url: https://mobile.mist.com/installers/marvisclient/windows/0.100.26/marvisclient-installer.zip version: 0.100.26 '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/states: parameters: [] get: tags: - Constants Definitions summary: listStates description: Return ISO state or province codes for the supplied country code. operationId: listStates parameters: - name: country_code in: query description: Country code, in [two-character]($e/Constants%20Definitions/listCountryCodes) required: true style: form explode: true schema: type: string examples: - US responses: '200': description: List of Countries headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_state' description: State and territory definitions returned by the constants API examples: - - iso_code: AK name: Alaska - iso_code: AL name: Alabama - iso_code: AS name: American Samoa - iso_code: AZ name: Arizona - iso_code: CA name: California contentMediaType: application/json examples: Example: value: - iso_code: AK name: Alaska - iso_code: AL name: Alabama - iso_code: AS name: American Samoa - iso_code: AZ name: Arizona - iso_code: CA name: California application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_state' description: State and territory definitions returned by the constants API examples: - - iso_code: AK name: Alaska - iso_code: AL name: Alabama - iso_code: AS name: American Samoa - iso_code: AZ name: Arizona - iso_code: CA name: California contentMediaType: application/vnd.api+json examples: Example: value: - iso_code: AK name: Alaska - iso_code: AL name: Alabama - iso_code: AS name: American Samoa - iso_code: AZ name: Arizona - iso_code: CA name: California '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/traffic_types: parameters: [] get: tags: - Constants Definitions summary: listTrafficTypes description: Return traffic type definitions used to classify recognized network traffic. operationId: listTrafficTypes parameters: [] responses: '200': description: List of Traffic Types headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_traffic_type' description: Traffic type definitions returned by the constants API examples: - - display: VoIP Video dscp: 32 failover_policy: non_revertible max_jitter: 250 max_latency: 1500 max_loss: 35 name: voip_video traffic_class: medium contentMediaType: application/json examples: Example: value: - display: VoIP Video dscp: 32 failover_policy: non_revertible max_jitter: 250 max_latency: 1500 max_loss: 35 name: voip_video traffic_class: medium application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_traffic_type' description: Traffic type definitions returned by the constants API examples: - - display: VoIP Video dscp: 32 failover_policy: non_revertible max_jitter: 250 max_latency: 1500 max_loss: 35 name: voip_video traffic_class: medium contentMediaType: application/vnd.api+json examples: Example: value: - display: VoIP Video dscp: 32 failover_policy: non_revertible max_jitter: 250 max_latency: 1500 max_loss: 35 name: voip_video traffic_class: medium '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/const/webhook_topics: parameters: [] get: tags: - Constants Definitions summary: listWebhookTopics description: Return webhook topic definitions that can be subscribed to in webhook configuration. operationId: listWebhookTopics parameters: [] responses: '200': description: List of Webhook Topics headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/const_webhook_topic' description: Webhook topic definitions returned by the constants API examples: - - for_org: true has_delivery_results: true key: alarms - key: asset-raw-rssi - for_org: true has_delivery_results: true key: audits - for_org: true key: client-info - for_org: true key: client-join - key: client-latency - for_org: true key: client-sessions - allows_single_event_per_message: true for_org: true key: device-events - for_org: true has_delivery_results: true key: device-updowns - for_org: true key: minis-reachability contentMediaType: application/json examples: Example: value: - for_org: true has_delivery_results: true key: alarms - key: asset-raw-rssi - for_org: true has_delivery_results: true key: audits - for_org: true key: client-info - for_org: true key: client-join - key: client-latency - for_org: true key: client-sessions - allows_single_event_per_message: true for_org: true key: device-events - for_org: true has_delivery_results: true key: device-updowns - for_org: true key: minis-reachability application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/const_webhook_topic' description: Webhook topic definitions returned by the constants API examples: - - for_org: true has_delivery_results: true key: alarms - key: asset-raw-rssi - for_org: true has_delivery_results: true key: audits - for_org: true key: client-info - for_org: true key: client-join - key: client-latency - for_org: true key: client-sessions - allows_single_event_per_message: true for_org: true key: device-events - for_org: true has_delivery_results: true key: device-updowns - for_org: true key: minis-reachability contentMediaType: application/vnd.api+json examples: Example: value: - for_org: true has_delivery_results: true key: alarms - key: asset-raw-rssi - for_org: true has_delivery_results: true key: audits - for_org: true key: client-info - for_org: true key: client-join - key: client-latency - for_org: true key: client-sessions - allows_single_event_per_message: true for_org: true key: device-events - for_org: true has_delivery_results: true key: device-updowns - for_org: true key: minis-reachability '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: const_app_subcategory_definition: title: const_app_subcategory_definition required: - display - key - traffic_type type: object properties: display: type: string description: Description of the app subcategory examples: - Office Document key: type: string description: Machine-readable application subcategory key examples: - Office_Documents traffic_type: type: string description: Type of traffic (QoS) of the app subcategory examples: - Images description: Application subcategory definition returned by the constants API response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response const_ap_channel: title: const_ap_channel type: object properties: band24_40mhz_allowed: type: boolean description: Whether 40 MHz channels are allowed on the 2.4 GHz band examples: - true band24_channels: type: object additionalProperties: type: array items: type: integer format: int32 description: Allowed 2.4 GHz channels for this country or regulatory domain example: '20': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 '40': - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 description: Allowed 2.4 GHz channels for this country or regulatory domain examples: - '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: type: boolean description: Whether the 2.4 GHz band is enabled for this country or regulatory domain examples: - true band5_channels: type: object additionalProperties: type: array items: type: integer format: int32 description: Allowed 5 GHz channels for this country or regulatory domain example: '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 description: Allowed 5 GHz channels for this country or regulatory domain examples: - '20': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 '40': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 '80': - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 dfs: - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 outdoor: - 36 - 40 - 44 - 48 - 52 - 56 - 60 - 64 - 100 - 104 - 108 - 112 - 116 - 120 - 124 - 128 - 132 - 136 - 140 - 144 - 149 - 153 - 157 - 161 - 165 band5_enabled: type: boolean description: Whether the 5 GHz band is enabled for this country or regulatory domain examples: - true band6_channels: type: object additionalProperties: type: array items: type: integer format: int32 description: Allowed 6 GHz channels for this country or regulatory domain example: '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 description: Allowed 6 GHz channels for this country or regulatory domain examples: - '160': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 '20': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 - 233 '40': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 - 225 - 229 '80': - 1 - 5 - 9 - 13 - 17 - 21 - 25 - 29 - 33 - 37 - 41 - 45 - 49 - 53 - 57 - 61 - 65 - 69 - 73 - 77 - 81 - 85 - 89 - 93 - 97 - 101 - 105 - 109 - 113 - 117 - 121 - 125 - 129 - 133 - 137 - 141 - 145 - 149 - 153 - 157 - 161 - 165 - 169 - 173 - 177 - 181 - 185 - 189 - 193 - 197 - 201 - 205 - 209 - 213 - 217 - 221 psc: - 5 - 21 - 37 - 53 - 69 - 85 - 101 - 117 - 133 - 149 - 165 - 181 - 197 - 213 - 229 band6_enabled: type: boolean description: Whether the 6 GHz band is enabled for this country or regulatory domain examples: - true certified: type: boolean description: Whether AP operation is certified for this country or regulatory domain examples: - true code: type: integer description: Country code, ISO 3166-1 numeric contentEncoding: int32 examples: - 840 dfs_ok: type: boolean description: Whether DFS channels are allowed in this country or regulatory domain examples: - true key: type: string description: Country code, in two-character examples: - US name: type: string description: Country or regulatory-domain display name examples: - United States uses: type: string description: Regulatory ruleset used for AP channel validation examples: - US_FCC description: Country and regulatory-domain channel capabilities for AP radios const_fingerprint_types: title: const_fingerprint_types type: object properties: family: uniqueItems: true type: array items: type: string description: Device family values available for client fingerprint matching mfg: uniqueItems: true type: array items: type: string description: Manufacturer values available for client fingerprint matching model: uniqueItems: true type: array items: type: string description: Device model values available for client fingerprint matching os: uniqueItems: true type: array items: type: string description: Operating system values available for client fingerprint matching description: Supported client fingerprint values for NAC matching const_gateway_applications_definition: title: const_gateway_applications_definition type: object properties: app_id: type: boolean description: Whether an AppID is defined for this gateway application examples: - true key: type: string description: Machine-readable key that identifies the gateway application examples: - 4shared name: type: string description: Display name of the gateway application examples: - 4shared ssr_app_id: type: boolean description: Whether an SSR AppID is defined for this gateway application examples: - true description: Gateway application definition returned by the constants API response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response const_traffic_type: title: const_traffic_type type: object properties: display: type: string description: Human-readable traffic type label examples: - VoIP Video dscp: type: integer description: Differentiated Services Code Point value used for this traffic type contentEncoding: int32 examples: - 32 failover_policy: type: string description: Failover behavior associated with this traffic type examples: - non_revertible max_jitter: type: integer description: Maximum jitter threshold for this traffic type, in milliseconds contentEncoding: int32 examples: - 250 max_latency: type: integer description: Maximum latency threshold for this traffic type, in milliseconds contentEncoding: int32 examples: - 1500 max_loss: type: integer description: Maximum packet loss threshold for this traffic type, in percent contentEncoding: int32 examples: - 35 name: type: string description: Machine-readable traffic type name examples: - voip_video traffic_class: type: string description: Traffic class associated with this traffic type examples: - medium description: Traffic type definition returned by the constants API const_country: title: const_country required: - alpha2 - certified - name - numeric type: object properties: alpha2: type: string description: Country code, in two-character examples: - FR certified: type: boolean description: Whether this country is certified for use in Mist APs examples: - true name: type: string description: Human-readable country name for display examples: - France numeric: type: number description: Country code, ISO 3166-1 numeric examples: - 250 description: Country definition returned by the constants API const_language: title: const_language required: - display - display_native - key type: object properties: display: type: string description: Localized language display name in the API default locale examples: - English (US) display_native: type: string description: Language display name in its native locale examples: - English (US) key: type: string description: Locale key used to select this language examples: - en-US description: Language option returned by the constants API const_application_definition: title: const_application_definition type: object properties: app_id: type: boolean description: Whether an AppID is defined for this application app_image_url: type: string description: URL of the application icon image, when one is available examples: - '""' app_probe: type: boolean description: Whether an application probe is available for this application category: type: string description: Application category key associated with this application examples: - FileSharing group: type: string description: Application group display name for this application examples: - File Sharing key: type: string description: Machine-readable key that identifies the application examples: - dropbox name: type: string description: Display name of the application examples: - Dropbox signature_based: type: boolean description: Whether this application is detected using signatures ssr_app_id: type: boolean description: Whether an SSR AppID is defined for this application description: Application definition recognized by Juniper Devices const_insight_metrics_property: title: const_insight_metrics_property type: object properties: ctype: uniqueItems: true type: array items: type: string description: Metric classification type labels for this insight metric description: type: string description: Human-readable description of the insight metric example: anyOf: - type: array items: $ref: '#/components/schemas/const_insight_metrics_property_example' - type: object additionalProperties: type: array items: $ref: '#/components/schemas/const_insight_metrics_property_example' description: Sample values returned for this insight metric intervals: type: object additionalProperties: $ref: '#/components/schemas/const_insight_metrics_property_interval' description: Supported time intervals and retention windows for this metric keys: type: object description: Additional key metadata for this insight metric params: type: object additionalProperties: $ref: '#/components/schemas/const_insight_metrics_property_param' description: Parameters supported when querying this insight metric report_durations: type: object additionalProperties: $ref: '#/components/schemas/const_insight_metrics_property_report_duration' description: Supported reporting durations for this insight metric report_scopes: uniqueItems: true type: array items: type: string description: Entity scopes supported when reporting this insight metric scopes: type: array items: $ref: '#/components/schemas/const_insight_metrics_property_scope' description: Entity scopes that can be queried for this insight metric sle_baselined: type: boolean description: Whether the insight metric uses an SLE baseline sle_classifiers: uniqueItems: true type: array items: type: string description: SLE classifiers associated with this insight metric type: type: string description: Metric data type, such as timeseries unit: type: string description: Measurement unit for values returned by this metric values: type: object description: Enumerated or structured value metadata for this insight metric description: Definition of an insight metric returned by the constants API const_insight_metrics_property_scope: title: const_insight_metrics_property_scope enum: - ap - client - device - gateway - map - msp - mxcluster - mxedge - org - otherdevice - rssizone - sdkclient - site - switch - wlan - zone type: string description: 'enum: `ap`, `client`, `device`, `gateway`, `map`, `msp`, `mxcluster`, `mxedge`, `org`, `otherdevice`, `rssizone`, `sdkclient`, `site`, `switch`, `wlan`, `zone`' const_webhook_topic: title: const_webhook_topic type: object properties: allows_single_event_per_message: type: boolean description: Whether this topic can be configured to enforce one event per webhook message for_org: type: boolean description: Whether this topic can be used in organization-level webhooks has_delivery_results: type: boolean description: Whether delivery-result search is available for this webhook topic internal: type: boolean description: Whether this topic is internal and not selectable in site or organization webhooks key: type: string description: Machine-readable key that identifies the webhook topic examples: - alarms description: Webhook topic definition returned by the constants API const_license_type: title: const_license_type type: object properties: description: type: string description: Human-readable description of the license type examples: - Wired Assurance 12 enforcement_level: allOf: - $ref: '#/components/schemas/const_license_type_enforcement_level' - description: 'Level at which the license is enforced. enum: `org`, `site`.' entitled_licenses: type: array items: type: string description: License type keys this license type entitles examples: - - sub_ex12 - sub_sadv1 group: type: string description: License group this license type belongs to examples: - SUB-WIRED includes: type: array items: type: string description: License SKU components included by this license type examples: - - sub_ex12a - sub_ex12p key: type: string description: Machine-readable license type key examples: - sub_ex12 name: type: string description: Display name of the license type examples: - SUB-EX12 type: type: string description: License type identifier (SKU) examples: - SUB-EX12 description: License type definition returned by the constants API const_insight_metrics_property_interval: title: const_insight_metrics_property_interval type: object properties: interval: type: integer description: Sampling interval length, in seconds contentEncoding: int32 max_age: type: integer description: Maximum lookback age for this interval, in seconds contentEncoding: int32 description: Interval definition for an insight metric const_marvisclient_event: title: const_marvisclient_event type: object properties: display: type: string description: Human-readable name for this Marvis Client event type examples: - Marvis Client Roamed key: type: string description: Event type key used in Marvis Client event search and count APIs examples: - MARVISCLIENT_ROAMED description: A Marvis Client event type definition const_ap_led: title: const_ap_led required: - code - description - key - name type: object properties: code: type: string description: Numeric LED status and `last_trouble` code reported by the AP examples: - '01' description: type: string description: Human-readable explanation of the AP status examples: - LED not working key: type: string description: Machine-readable AP status key examples: - LED_FAILURE name: type: string description: Display name for the AP status examples: - LED Failure description: AP LED status and `last_trouble` code definition returned by the constants API const_insight_metrics_property_example: anyOf: - type: integer contentEncoding: int32 - type: number - type: string - type: boolean - type: object description: Example value for an insight metric property const_license_type_enforcement_level: title: const_license_type_enforcement_level enum: - org - site type: string description: 'Level at which the license is enforced. enum: `org`, `site`.' const_ap_esl_version: title: const_ap_esl_version type: object properties: esl_version: type: string description: Electronic Shelf Label (ESL) package version supported by the AP model readOnly: true examples: - 2.5.1 model: type: string description: AP model that supports the listed ESL version readOnly: true examples: - AP34 description: Supported Electronic Shelf Label (ESL) version for an AP model const_state: title: const_state type: object properties: iso_code: type: string description: ISO subdivision code for the state or territory examples: - AK name: type: string description: State or territory display name examples: - Alaska description: State or territory definition returned by the constants API const_insight_metrics_property_param: title: const_insight_metrics_property_param type: object properties: required: type: boolean description: Whether this query parameter is required description: Query parameter definition for an insight metric const_app_category_definition: title: const_app_category_definition required: - display - key type: object properties: display: type: string description: Description of the app category examples: - Images filters: allOf: - $ref: '#/components/schemas/const_app_category_definition_filters2' - description: Platform-specific application signatures included in this category examples: - srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers includes: type: array items: type: string description: Application categories included by this aggregate category key: type: string description: Machine-readable application category key examples: - Images description: Application category definition returned by the constants API response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response const_insight_metrics_property_report_duration: title: const_insight_metrics_property_report_duration type: object properties: duration: type: integer description: Report duration length, in seconds contentEncoding: int32 interval: type: integer description: Sampling interval used for this report duration, in seconds contentEncoding: int32 description: Report duration definition for an insight metric const_app_category_definition_filters2: title: const_app_category_definition_filters2 type: object properties: srx: uniqueItems: true type: array items: type: string description: Application signature names for SRX platforms included in this category ssr: uniqueItems: true type: array items: type: string description: Application identifiers for SSR platforms included in this category description: Platform-specific application signatures included in this category examples: - srx: - Enhanced_Images_Media - Enhanced_Web_Images - Enhanced_Image_Servers response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response const_marvis_client_version: title: const_marvis_client_version type: object properties: label: type: string description: Release label for this Marvis Client version examples: - default notes: type: string description: Release notes or extra text for this Marvis Client version os: type: string description: Operating system supported by this Marvis Client installer examples: - windows url: type: string description: Download URL for this Marvis Client installer examples: - https://mobile.mist.com/installers/marvisclient/... version: type: string description: Marvis Client software version for this installer examples: - 0.100.29 description: Marvis Client version download entry securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header