openapi: 3.2.0 info: title: Mist Sites MxEdges 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: Sites MxEdges description: MxEdges (Mist Edges) at the site level are deployed to tunnel traffic at each site due to network constraints or security concerns. paths: /api/v1/sites/{site_id}/mxedges: parameters: [] get: tags: - Sites MxEdges summary: listSiteMxEdges description: List Mist Edges for a site. Use List Org Mist Edges to retrieve Mist Edges across the organization. operationId: listSiteMxEdges parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/mxedge' description: List of Mist Edge appliances examples: - - cpu_stat: cpus: cpu0: idle: 79 interrupt: 0 system: 4 usage: 20 user: 16 cpu1: idle: 93 interrupt: 0 system: 4 usage: 6 user: 1 idle: 87 interrupt: 0 system: 5 usage: 12 user: 7 ext_ip: 116.187.144.16 id: 387804a7-3474-85ce-15a2-f9a9684c9c90 ip_stat: ip: 172.16.5.3 ips: ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64 lag_stat: lag0: active_ports: - '0' - '1' last_seen: 1547437078 magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD memory_stats: active: 1061085184 available: 4124860416 buffers: 789495808 cached: 718016512 free: 2818838528 inactive: 458158080 swap_cached: 0 swap_free: 8161062912 swap_total: 8161062912 total: 7947616256 usage: 65 model: ME-S2019 mxagent_registered: false mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 name: Guest num_tunnels: 31 port_stat: eth0: full_duplex: true lldp_stats: mgmt_addr: 122.16.3.11 port_desc: GigabitEthernet4/0/16 port_id: Gi4/0/16 system_desc: Cisco IOS Software system_name: ME-DC2-DIS-SW rx_bytes: 2056 rx_errors: 0 rx_pkts: 670 speed: 1000 tx_bytes: 2056 tx_pkts: 670 up: true eth1: up: false module: up: false status: connected tunterm_registered: false tunterm_stat: monitoring_failed: false uptime: 884221 version: 0.1.2 virtualization_type: VirtualizationVMware contentMediaType: application/json examples: Example: value: - cpu_stat: cpus: cpu0: idle: 79 interrupt: 0 system: 4 usage: 20 user: 16 cpu1: idle: 93 interrupt: 0 system: 4 usage: 6 user: 1 idle: 87 interrupt: 0 system: 5 usage: 12 user: 7 ext_ip: 116.187.144.16 id: 387804a7-3474-85ce-15a2-f9a9684c9c90 ip_stat: ip: 172.16.5.3 ips: ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64 lag_stat: lag0: active_ports: - '0' - '1' last_seen: 1547437078 magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD memory_stats: active: 1061085184 available: 4124860416 buffers: 789495808 cached: 718016512 free: 2818838528 inactive: 458158080 swap_cached: 0 swap_free: 8161062912 swap_total: 8161062912 total: 7947616256 usage: 65 model: ME-S2019 mxagent_registered: false mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 name: Guest num_tunnels: 31 port_stat: eth0: full_duplex: true lldp_stats: mgmt_addr: 122.16.3.11 port_desc: GigabitEthernet4/0/16 port_id: Gi4/0/16 system_desc: Cisco IOS Software system_name: ME-DC2-DIS-SW rx_bytes: 2056 rx_errors: 0 rx_pkts: 670 speed: 1000 tx_bytes: 2056 tx_pkts: 670 up: true eth1: up: false module: up: false status: connected tunterm_registered: false tunterm_stat: monitoring_failed: false uptime: 884221 version: 0.1.2 virtualization_type: VirtualizationVMware application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/mxedge' description: List of Mist Edge appliances examples: - - cpu_stat: cpus: cpu0: idle: 79 interrupt: 0 system: 4 usage: 20 user: 16 cpu1: idle: 93 interrupt: 0 system: 4 usage: 6 user: 1 idle: 87 interrupt: 0 system: 5 usage: 12 user: 7 ext_ip: 116.187.144.16 id: 387804a7-3474-85ce-15a2-f9a9684c9c90 ip_stat: ip: 172.16.5.3 ips: ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64 lag_stat: lag0: active_ports: - '0' - '1' last_seen: 1547437078 magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD memory_stats: active: 1061085184 available: 4124860416 buffers: 789495808 cached: 718016512 free: 2818838528 inactive: 458158080 swap_cached: 0 swap_free: 8161062912 swap_total: 8161062912 total: 7947616256 usage: 65 model: ME-S2019 mxagent_registered: false mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 name: Guest num_tunnels: 31 port_stat: eth0: full_duplex: true lldp_stats: mgmt_addr: 122.16.3.11 port_desc: GigabitEthernet4/0/16 port_id: Gi4/0/16 system_desc: Cisco IOS Software system_name: ME-DC2-DIS-SW rx_bytes: 2056 rx_errors: 0 rx_pkts: 670 speed: 1000 tx_bytes: 2056 tx_pkts: 670 up: true eth1: up: false module: up: false status: connected tunterm_registered: false tunterm_stat: monitoring_failed: false uptime: 884221 version: 0.1.2 virtualization_type: VirtualizationVMware contentMediaType: application/vnd.api+json examples: Example: value: - cpu_stat: cpus: cpu0: idle: 79 interrupt: 0 system: 4 usage: 20 user: 16 cpu1: idle: 93 interrupt: 0 system: 4 usage: 6 user: 1 idle: 87 interrupt: 0 system: 5 usage: 12 user: 7 ext_ip: 116.187.144.16 id: 387804a7-3474-85ce-15a2-f9a9684c9c90 ip_stat: ip: 172.16.5.3 ips: ens192: 172.16.5.3/24,fe81::20c:29ff:fef8:d18e/64 lag_stat: lag0: active_ports: - '0' - '1' last_seen: 1547437078 magic: ExNpT5gi-ADR8WTFd4EiQPY3cP5WdSoD memory_stats: active: 1061085184 available: 4124860416 buffers: 789495808 cached: 718016512 free: 2818838528 inactive: 458158080 swap_cached: 0 swap_free: 8161062912 swap_total: 8161062912 total: 7947616256 usage: 65 model: ME-S2019 mxagent_registered: false mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 name: Guest num_tunnels: 31 port_stat: eth0: full_duplex: true lldp_stats: mgmt_addr: 122.16.3.11 port_desc: GigabitEthernet4/0/16 port_id: Gi4/0/16 system_desc: Cisco IOS Software system_name: ME-DC2-DIS-SW rx_bytes: 2056 rx_errors: 0 rx_pkts: 670 speed: 1000 tx_bytes: 2056 tx_pkts: 670 up: true eth1: up: false module: up: false status: connected tunterm_registered: false tunterm_stat: monitoring_failed: false uptime: 884221 version: 0.1.2 virtualization_type: VirtualizationVMware '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/sites/{site_id}/mxedges/events/count: parameters: [] get: tags: - Sites MxEdges summary: countSiteMxEdgeEvents description: Count by Distinct Attributes of Mist Edge Events operationId: countSiteMxEdgeEvents parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: distinct in: query description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`' style: form explode: true schema: allOf: - $ref: '#/components/schemas/site_mxedge_events_count_distinct' - description: 'Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`' - name: mxedge_id in: query description: Filter results by Mist Edge identifier style: form explode: true schema: type: string - name: mxcluster_id in: query description: Mist edge cluster id style: form explode: true schema: type: string - name: type in: query description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions) style: form explode: true schema: type: string - name: service in: query description: Filter results by service name style: form explode: true schema: type: string - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 responses: '200': description: Result of Count headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_count' - description: Distinct count response for time-bounded search results examples: - distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 contentMediaType: application/vnd.api+json examples: Example: value: distinct: string end: 0 limit: 0 results: - count: 0 property: string start: 0 total: 0 '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/sites/{site_id}/mxedges/events/search: parameters: [] get: tags: - Sites MxEdges summary: searchSiteMistEdgeEvents description: Search Mist Edge events for a site with filters for Mist Edge, Mist Edge cluster, event type, service, component, and time range. Use Search Org Mist Edge Events to search Mist Edge events across the organization. operationId: searchSiteMistEdgeEvents parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mxedge_id in: query description: Filter results by Mist Edge identifier style: form explode: true schema: type: string - name: mxcluster_id in: query description: Mist edge cluster id style: form explode: true schema: type: string - name: type in: query description: See [List Device Events Definitions]($e/Constants%20Events/listDeviceEventsDefinitions) style: form explode: true schema: type: string - name: service in: query description: Filter results by service name style: form explode: true schema: type: string - name: component in: query description: Filter results by component name style: form explode: true schema: type: string - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 10 - name: start in: query description: Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w` style: form explode: true schema: type: string - name: end in: query description: Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now` style: form explode: true schema: type: string - name: duration in: query description: Time range duration for the query, using relative units such as `10m`, `7d`, or `2w` style: form explode: true schema: type: string default: 1d examples: - 10m - name: sort in: query description: On which field the list should be sorted, -prefix represents DESC order style: form explode: true schema: type: string default: timestamp examples: - -site_id - name: search_after in: query description: Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed. style: form explode: true schema: type: string responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_mxedge_events_search' - description: Search response for Mist Edge event records examples: - end: 1694708579 limit: 10 page: 3 results: - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05 mxedge_id: 00000000-0000-0000-1000-020000dc585c org_id: f2695c32-0e83-4936-b1b2-96fc88051213 service: tunterm timestamp: 1694678225.927 type: ME_SERVICE_STOPPED start: 1694622179 contentMediaType: application/json examples: Example: value: end: 1694708579 limit: 10 page: 3 results: - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05 mxedge_id: 00000000-0000-0000-1000-020000dc585c org_id: f2695c32-0e83-4936-b1b2-96fc88051213 service: tunterm timestamp: 1694678225.927 type: ME_SERVICE_STOPPED start: 1694622179 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_mxedge_events_search' - description: Search response for Mist Edge event records examples: - end: 1694708579 limit: 10 page: 3 results: - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05 mxedge_id: 00000000-0000-0000-1000-020000dc585c org_id: f2695c32-0e83-4936-b1b2-96fc88051213 service: tunterm timestamp: 1694678225.927 type: ME_SERVICE_STOPPED start: 1694622179 contentMediaType: application/vnd.api+json examples: Example: value: end: 1694708579 limit: 10 page: 3 results: - mxcluster_id: 2815c917-58e7-472f-a190-bfd44fb58d05 mxedge_id: 00000000-0000-0000-1000-020000dc585c org_id: f2695c32-0e83-4936-b1b2-96fc88051213 service: tunterm timestamp: 1694678225.927 type: ME_SERVICE_STOPPED start: 1694622179 '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/sites/{site_id}/mxedges/{mxedge_id}: parameters: [] delete: tags: - Sites MxEdges summary: deleteSiteMxEdge description: Delete Site Mist Edge operationId: deleteSiteMxEdge parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mxedge_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: {} '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 get: tags: - Sites MxEdges summary: getSiteMxEdge description: Get Site Mist Edge operationId: getSiteMxEdge parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mxedge_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: {} '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 put: tags: - Sites MxEdges summary: updateSiteMxEdge description: Update Site Mist Edge settings operationId: updateSiteMxEdge parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mxedge_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/mxedge' required: false responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/mxedge' - description: Mist Edge appliance configuration and registration state examples: - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6 magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD model: ME-100 mxagent_registered: true mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 mxedge_mgmt: mist_password: MIST_PASSWORD root_password: ROOT_PASSWORD name: Guest ntp_servers: [] oob_ip_config: dns: - 8.8.8.8 - 4.4.4.4 gateway: 10.2.1.254 ip: 10.2.1.10 netmask: 255.255.255.0 type: static tunterm_dhcpd_config: '2': enabled: true servers: - 11.2.3.44 enabled: false servers: - 11.2.3.4 tunterm_extra_routes: 11.0.0.0/8: via: 10.3.3.1 tunterm_ip_config: gateway: 10.2.1.254 ip: 10.2.1.1 netmask: 255.255.255.0 contentMediaType: application/json examples: Example: value: id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6 magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD model: ME-100 mxagent_registered: true mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 mxedge_mgmt: mist_password: MIST_PASSWORD root_password: ROOT_PASSWORD name: Guest ntp_servers: [] oob_ip_config: dns: - 8.8.8.8 - 4.4.4.4 gateway: 10.2.1.254 ip: 10.2.1.10 netmask: 255.255.255.0 type: static tunterm_dhcpd_config: '2': enabled: true servers: - 11.2.3.44 enabled: false servers: - 11.2.3.4 tunterm_extra_routes: 11.0.0.0/8: via: 10.3.3.1 tunterm_ip_config: gateway: 10.2.1.254 ip: 10.2.1.1 netmask: 255.255.255.0 application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/mxedge' - description: Mist Edge appliance configuration and registration state examples: - id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6 magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD model: ME-100 mxagent_registered: true mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 mxedge_mgmt: mist_password: MIST_PASSWORD root_password: ROOT_PASSWORD name: Guest ntp_servers: [] oob_ip_config: dns: - 8.8.8.8 - 4.4.4.4 gateway: 10.2.1.254 ip: 10.2.1.10 netmask: 255.255.255.0 type: static tunterm_dhcpd_config: '2': enabled: true servers: - 11.2.3.44 enabled: false servers: - 11.2.3.4 tunterm_extra_routes: 11.0.0.0/8: via: 10.3.3.1 tunterm_ip_config: gateway: 10.2.1.254 ip: 10.2.1.1 netmask: 255.255.255.0 contentMediaType: application/vnd.api+json examples: Example: value: id: 95ddd29a-6a3c-929e-a431-51a5b09f36a6 magic: L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD model: ME-100 mxagent_registered: true mxcluster_id: 572586b7-f97b-a22b-526c-8b97a3f609c4 mxedge_mgmt: mist_password: MIST_PASSWORD root_password: ROOT_PASSWORD name: Guest ntp_servers: [] oob_ip_config: dns: - 8.8.8.8 - 4.4.4.4 gateway: 10.2.1.254 ip: 10.2.1.10 netmask: 255.255.255.0 type: static tunterm_dhcpd_config: '2': enabled: true servers: - 11.2.3.44 enabled: false servers: - 11.2.3.4 tunterm_extra_routes: 11.0.0.0/8: via: 10.3.3.1 tunterm_ip_config: gateway: 10.2.1.254 ip: 10.2.1.1 netmask: 255.255.255.0 '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/sites/{site_id}/mxedges/{mxedge_id}/support: parameters: [] post: tags: - Sites MxEdges summary: uploadSiteMxEdgeSupportFiles description: Support / Upload Mist Edge support files operationId: uploadSiteMxEdgeSupportFiles parameters: - name: site_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: mxedge_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: {} '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: mxedge_tunterm_switch_config: title: mxedge_tunterm_switch_config type: object properties: port_vlan_id: type: integer description: Untagged VLAN ID for this tunnel termination switch port contentEncoding: int32 vlan_ids: type: array items: $ref: '#/components/schemas/vlan_id_with_variable' description: List of tagged VLAN IDs allowed on this tunnel termination switch port description: Switch VLAN settings for one tunnel termination port 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 mxedge_tunterm_extra_route: title: mxedge_tunterm_extra_route type: object properties: via: type: string description: Next-hop IP address for this Mist Tunnel extra route description: Extra route for Mist Tunnel traffic on a Mist Edge response_mxedge_events_search: title: response_mxedge_events_search type: object properties: end: type: integer description: Epoch timestamp for the end of the Mist Edge event search window contentEncoding: int32 examples: - 1694708579 limit: type: integer description: Maximum number of Mist Edge event records returned in this page contentEncoding: int32 examples: - 10 next: type: string description: Pagination cursor or URL for retrieving the next page of Mist Edge event records page: type: integer description: Returned page number for Mist Edge event records contentEncoding: int32 examples: - 3 results: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/mxedge_event' description: Mist Edge event records matching the search filters start: type: integer description: Epoch timestamp for the start of the Mist Edge event search window contentEncoding: int32 examples: - 1694622179 description: Search response for Mist Edge event records 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 mxedge_tunterm_ip_config2: title: mxedge_tunterm_ip_config2 required: - gateway - ip - netmask type: object properties: gateway: type: string description: IPv4 gateway for the Mist Tunnel interface examples: - 10.2.1.254 gateway6: type: string description: IPv6 gateway for the Mist Tunnel interface examples: - 2001:1010:1010:1010::1 ip: type: string description: Address on the untagged Mist Tunnel interface, in IPv4 format examples: - 10.2.1.1 ip6: type: string description: Address on the Mist Tunnel interface, in IPv6 format examples: - 2001:1010:1010:1010::2 netmask: type: string description: Subnet mask for the Mist Tunnel IPv4 address examples: - 255.255.255.0 netmask6: type: string description: Prefix length for the Mist Tunnel IPv6 address examples: - /64 description: Tunnel termination IP configuration for the Mist Edge mxedge_mgmt_oob_ip_type62: title: mxedge_mgmt_oob_ip_type62 enum: - autoconf - dhcp - disabled - static type: string description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.' mxedge_tunterm_igmp_snooping_querier2: title: mxedge_tunterm_igmp_snooping_querier2 type: object properties: max_response_time: type: integer description: Querier's query response interval, in tenths-of-seconds contentEncoding: int32 examples: - 10 mtu: type: integer description: The MTU we use (needed when forming large IGMPv3 Reports) contentEncoding: int32 examples: - 1500 query_interval: type: integer description: Querier's query interval, in seconds contentEncoding: int32 examples: - 125 robustness: maximum: 7 minimum: 1 type: integer description: IGMP querier robustness variable contentEncoding: int32 version: type: integer description: Querier's maximum protocol version contentEncoding: int32 examples: - 3 description: IGMP querier settings used with tunnel termination snooping 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 event_severity1: title: event_severity1 enum: - normal - critical - high - warning type: string description: 'Event severity level reported for this Mist Edge event. enum: `normal`, `critical`, `high`, `warning`.' mxedge_tunterm_multicast_config: title: mxedge_tunterm_multicast_config type: object properties: mdns: allOf: - $ref: '#/components/schemas/mxedge_tunterm_multicast_mdns2' - description: Settings for mDNS forwarding on tunnel termination VLANs ssdp: allOf: - $ref: '#/components/schemas/mxedge_tunterm_multicast_ssdp2' - description: Settings for SSDP forwarding on tunnel termination VLANs description: Multicast forwarding settings for tunnel termination mxedge_tunterm_switch_configs2: title: mxedge_tunterm_switch_configs2 type: object properties: enabled: type: boolean description: Whether custom tunnel termination switch VLAN settings are enabled additionalProperties: allOf: - $ref: '#/components/schemas/mxedge_tunterm_switch_config' - description: Switch VLAN settings for one tunnel termination port description: Switch VLAN settings for tunnel termination tunterm_port_config3: title: tunterm_port_config3 type: object properties: downstream_ports: type: array items: type: string description: Ports connected downstream toward APs for tunnel termination examples: - - '2' - '3' separate_upstream_downstream: type: boolean description: Whether to separate upstream / downstream ports. default is false where all ports will be used. default: false upstream_port_vlan_id: oneOf: - type: string - maximum: 4094 minimum: 1 type: integer contentEncoding: int32 description: Native VLAN ID applied to upstream tunnel termination ports upstream_ports: type: array items: type: string description: Ports connected upstream toward the LAN for tunnel termination examples: - - '0' - '1' description: Port configuration for tunnel termination traffic tunterm_monitoring_item: title: tunterm_monitoring_item type: object properties: host: minLength: 1 type: string description: Can be ip, ipv6, hostname examples: - 10.2.8.15 port: type: integer description: When `protocol`==`tcp`, TCP port checked by the monitoring probe contentEncoding: int32 examples: - 80 protocol: allOf: - $ref: '#/components/schemas/tunterm_monitoring_protocol2' - minLength: 1 description: 'Monitoring method used for this tunnel termination check. enum: `arp`, `ping`, `tcp`.' examples: - tcp src_vlan_id: type: integer description: Optional source for the monitoring check, vlan_id configured in tunterm_other_ip_configs contentEncoding: int32 examples: - 5 timeout: type: integer description: Maximum time for this monitoring check, in seconds contentEncoding: int32 default: 300 examples: - 300 description: Monitoring check for tunnel termination reachability mxedge_tunterm_dhcpd_type2: title: mxedge_tunterm_dhcpd_type2 const: relay type: string description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`.' mxedge_tunterm_dhcpd_config_type2: title: mxedge_tunterm_dhcpd_config_type2 const: relay type: string description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`.' mxedge_tunterm_dhcpd_config_property: title: mxedge_tunterm_dhcpd_config_property type: object properties: enabled: type: boolean description: Whether DHCP relay is enabled for this tunneled VLAN default: false servers: type: array items: type: string description: DHCP relay server addresses used by this tunneled VLAN type: allOf: - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_type2' - description: 'DHCP handling mode for this tunneled VLAN. enum: `relay`.' description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN mxedge_versions2: title: mxedge_versions2 type: object properties: mxagent: type: string description: Reported version of the mxagent service readOnly: true tunterm: type: string description: Reported version of the tunnel termination service readOnly: true description: Service version information reported by the Mist Edge ip_type10: title: ip_type10 enum: - dhcp - static type: string description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.' examples: - static site_mxedge_events_count_distinct: title: site_mxedge_events_count_distinct enum: - mxcluster_id - mxedge_id - package - type type: string description: 'enum: `mxcluster_id`, `mxedge_id`, `package`, `type`' vlan_id_with_variable: oneOf: - type: string - maximum: 4094 minimum: 1 type: integer contentEncoding: int32 description: VLAN ID, either numeric or expressed as a template variable string mxedge_event: title: mxedge_event type: object properties: audit_id: type: string description: Audit log identifier associated with this event, when available contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f component: type: - string - 'null' description: Mist Edge component that reported the event, such as a power supply or fan examples: - PS1 - Fan1 device_id: type: - string - 'null' description: Identifier of the device associated with the event, when available contentEncoding: uuid readOnly: true device_type: type: string description: Device type associated with the event from_version: type: string description: Service version before an upgrade-related event mac: type: string description: Mist Edge MAC address associated with the event mxcluster_id: type: string description: Mist Edge cluster identifier associated with the event examples: - 2815c917-58e7-472f-a190-bfd44fb58d05 mxedge_id: type: string description: Mist Edge identifier associated with the event examples: - 00000000-0000-0000-1000-020000dc585c mxedge_name: type: string description: Display name of the Mist Edge associated with the event org_id: type: string description: Identifier of the org where the event occurred contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 package: type: string description: Software package associated with the event service: type: string description: Mist Edge service associated with the event examples: - tunterm severity: allOf: - $ref: '#/components/schemas/event_severity1' - description: 'Event severity level reported for this Mist Edge event. enum: `normal`, `critical`, `high`, `warning`.' sys_info.usage: allOf: - $ref: '#/components/schemas/mxedge_event_sys_info2' - description: System resource usage details associated with the event text: type: string description: Human-readable message describing the Mist Edge event timestamp: type: number description: Time when the Mist Edge event occurred readOnly: true to_version: type: string description: Service version after an upgrade-related event type: type: string description: Mist Edge event type code examples: - ME_SERVICE_STOPPED description: Event reported for a Mist Edge appliance or service mxedge_event_sys_info2: title: mxedge_event_sys_info2 type: object properties: resource: type: string description: System resource referenced by the event severity: allOf: - $ref: '#/components/schemas/event_severity2' - description: 'Event severity for the system resource condition. enum: `normal`, `critical`, `high`, `warning`.' description: System resource usage details associated with the event mxedge_tunterm_dhcpd_config2: title: mxedge_tunterm_dhcpd_config2 type: object properties: enabled: type: boolean description: Whether DHCP relay is enabled for Mist Tunneled VLANs default: false servers: type: array items: type: string description: DHCP relay server addresses used when `type`==`relay` type: allOf: - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_type2' - description: 'DHCP handling mode for the global tunnel termination config. enum: `relay`.' additionalProperties: allOf: - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config_property' - description: Per-VLAN DHCP relay settings for a Mist Tunneled VLAN description: DHCP relay or server settings for Mist Tunneled VLANs mxedge_mgmt_oob_ip_type2: title: mxedge_mgmt_oob_ip_type2 enum: - dhcp - disabled - static type: string description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.' mxedge_tunterm_igmp_snooping_config2: title: mxedge_tunterm_igmp_snooping_config2 type: object properties: enabled: oneOf: - type: boolean default: false - type: string default: 'False' description: Whether IGMP snooping is enabled for the configured VLANs querier: allOf: - $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_querier2' - description: IGMP querier settings used with tunnel termination snooping vlan_ids: anyOf: - type: array items: maximum: 4096 minimum: 0 type: integer contentEncoding: int32 - type: string description: List of VLAN IDs where tunnel termination performs IGMP snooping description: IGMP snooping settings for Mist Tunneled VLANs mxedge_oob_ip_config3: title: mxedge_oob_ip_config3 type: object properties: autoconf6: type: boolean description: Whether IPv6 autoconfiguration is enabled on the out-of-band management interface default: true dhcp6: type: boolean description: Whether DHCPv6 is enabled on the out-of-band management interface default: true dns: type: array items: type: string description: Name server addresses for out-of-band management default: - 8.8.8.8 - 8.8.4.4 - 2001:4860:4860::8888 - 2001:4860:4860::8844 examples: - - 8.8.8.8 - 4.4.4.4 - 2001:4860:4860::8888 - 2001:4860:4860::8844 gateway: type: string description: If `type`=`static`, IPv4 default gateway for the out-of-band management interface examples: - 10.2.1.254 gateway6: type: string description: If `type6`=`static`, IPv6 default gateway for the out-of-band management interface examples: - 2601:1700:43c0:dc0::1 ip: type: string description: If `type`=`static`, IPv4 address for the out-of-band management interface examples: - 10.2.1.2 ip6: type: string description: If `type6`=`static`, IPv6 address for the out-of-band management interface examples: - 2601:1700:43c0:dc0:20c:29ff:fea7:93bc netmask: type: string description: If `type`=`static`, IPv4 netmask for the out-of-band management interface examples: - 255.255.255.0 netmask6: type: string description: If `type6`=`static`, IPv6 prefix length for the out-of-band management interface examples: - /64 type: allOf: - $ref: '#/components/schemas/ip_type9' - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.' examples: - static type6: allOf: - $ref: '#/components/schemas/ip_type10' - description: 'IPv6 address assignment mode for out-of-band management. enum: `dhcp`, `static`.' examples: - static description: Out-of-band management IP configuration for the Mist Edge proxy1: title: proxy1 type: object properties: disabled: type: boolean description: Whether this proxy configuration is disabled default: false examples: - true url: type: string description: Proxy URL used to reach Mist examples: - https://proxy.corp.com:8080/ description: Network proxy settings used by the Mist Edge mxedge_tunterm_multicast_mdns2: title: mxedge_tunterm_multicast_mdns2 type: object properties: enabled: type: boolean description: Whether mDNS forwarding is enabled for the configured VLANs vlan_ids: uniqueItems: true type: array items: type: string description: List of VLAN IDs where mDNS forwarding is enabled description: Settings for mDNS forwarding on tunnel termination VLANs ip_type9: title: ip_type9 enum: - dhcp - static type: string description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `static`.' examples: - static count_result: title: count_result required: - count type: object properties: count: type: integer description: Number of matching items for the distinct value or values in this result contentEncoding: int32 additionalProperties: type: string description: Count result row with the matching distinct field values event_severity2: title: event_severity2 enum: - normal - critical - high - warning type: string description: 'Event severity for the system resource condition. enum: `normal`, `critical`, `high`, `warning`.' 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 mxedge_mgmt1: title: mxedge_mgmt1 type: object properties: config_auto_revert: type: boolean description: Whether the Mist Edge automatically reverts configuration changes if connectivity is lost default: false fips_enabled: type: boolean description: Whether FIPS mode is enabled on the Mist Edge default: false mist_password: type: string description: Password for the Mist service account on the Mist Edge examples: - MIST_PASSWORD oob_ip_type: allOf: - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type2' - description: 'IPv4 address assignment mode for out-of-band management. enum: `dhcp`, `disabled`, `static`.' oob_ip_type6: allOf: - $ref: '#/components/schemas/mxedge_mgmt_oob_ip_type62' - description: 'IPv6 address assignment mode for out-of-band management. enum: `autoconf`, `dhcp`, `disabled`, `static`.' root_password: type: string description: Root account password for the Mist Edge contentEncoding: password examples: - ROOT_PASSWORD description: Management credentials and settings for the Mist Edge mxedge_tunterm_other_ip_config: title: mxedge_tunterm_other_ip_config required: - ip - netmask type: object properties: ip: type: string description: Address for the additional Mist Tunnel interface, in IPv4 format netmask: type: string description: Subnet mask for the additional Mist Tunnel IPv4 address description: Additional IP configuration for a Mist Tunnel VLAN interface response_count: title: response_count required: - distinct - end - limit - results - start - total type: object properties: distinct: type: string description: Field used to group the count results end: type: integer description: Search window end timestamp for the count request, in epoch seconds contentEncoding: int32 limit: type: integer description: Maximum number of distinct count results requested contentEncoding: int32 results: uniqueItems: true type: array items: $ref: '#/components/schemas/count_result' description: Count results grouped by the distinct field start: type: integer description: Search window start timestamp for the count request, in epoch seconds contentEncoding: int32 total: type: integer description: Number of distinct result buckets returned contentEncoding: int32 description: Distinct count response for time-bounded search results 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 mxedge_tunterm_multicast_ssdp2: title: mxedge_tunterm_multicast_ssdp2 type: object properties: enabled: type: boolean description: Whether SSDP forwarding is enabled for the configured VLANs vlan_ids: uniqueItems: true type: array items: type: string description: List of VLAN IDs where SSDP forwarding is enabled description: Settings for SSDP forwarding on tunnel termination VLANs tunterm_monitoring_protocol2: title: tunterm_monitoring_protocol2 enum: - arp - ping - tcp type: string description: 'Monitoring method used for this tunnel termination check. enum: `arp`, `ping`, `tcp`.' examples: - tcp mxedge: title: mxedge required: - model - name type: object properties: created_time: type: number description: Timestamp when the Mist Edge record was created readOnly: true for_site: type: boolean description: Whether this Mist Edge is scoped to a site readOnly: true id: type: string description: Unique identifier of the Mist Edge contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f mac: type: string description: Mist Edge MAC address readOnly: true examples: - 0200009fbe65 magic: type: string description: Registration claim code for the Mist Edge readOnly: true examples: - L-NpT5gi-ADR8WTFd4EiQPY3cP5WdSoD model: type: string description: Mist Edge hardware or virtual appliance model examples: - ME-100 modified_time: type: number description: Timestamp when the Mist Edge record was last modified readOnly: true mxagent_registered: type: boolean description: Whether the Mist Edge agent has registered with Mist cloud readOnly: true mxcluster_id: type: - string - 'null' description: Mist Edge cluster identifier that this appliance belongs to contentEncoding: uuid examples: - 572586b7-f97b-a22b-526c-8b97a3f609c4 mxedge_mgmt: allOf: - $ref: '#/components/schemas/mxedge_mgmt1' - description: Management credentials and settings for the Mist Edge name: type: string description: Display name of the Mist Edge examples: - Guest notes: type: string description: Free-form notes for the Mist Edge examples: - note for mxedge ntp_servers: uniqueItems: true type: array items: type: string description: Time synchronization servers used by the Mist Edge oob_ip_config: allOf: - $ref: '#/components/schemas/mxedge_oob_ip_config3' - description: Out-of-band management IP configuration for the Mist Edge org_id: type: string description: Identifier of the org that owns the Mist Edge contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 proxy: allOf: - $ref: '#/components/schemas/proxy1' - description: Network proxy settings used by the Mist Edge services: type: array items: type: string description: List of services enabled to run on the Mist Edge site_id: type: string description: Identifier of the site when the Mist Edge is site-scoped contentEncoding: uuid readOnly: true examples: - 441a1214-6928-442a-8e92-e1d34b8ec6a6 tunterm_dhcpd_config: allOf: - $ref: '#/components/schemas/mxedge_tunterm_dhcpd_config2' - description: DHCP relay or server settings for Mist Tunneled VLANs tunterm_extra_routes: type: object additionalProperties: $ref: '#/components/schemas/mxedge_tunterm_extra_route' description: Extra routes for Mist Tunneled VLAN traffic; property key is a CIDR tunterm_igmp_snooping_config: allOf: - $ref: '#/components/schemas/mxedge_tunterm_igmp_snooping_config2' - description: IGMP snooping settings for Mist Tunneled VLANs tunterm_ip_config: allOf: - $ref: '#/components/schemas/mxedge_tunterm_ip_config2' - description: Tunnel termination IP configuration for the Mist Edge tunterm_monitoring: type: array items: type: array items: $ref: '#/components/schemas/tunterm_monitoring_item' description: Monitoring checks for tunnel termination reachability tunterm_multicast_config: allOf: - $ref: '#/components/schemas/mxedge_tunterm_multicast_config' - description: Multicast forwarding settings for tunnel termination tunterm_other_ip_configs: type: object additionalProperties: $ref: '#/components/schemas/mxedge_tunterm_other_ip_config' description: IPconfigs by VLAN ID. Property key is the VLAN ID tunterm_port_config: allOf: - $ref: '#/components/schemas/tunterm_port_config3' - description: Port configuration for tunnel termination traffic tunterm_registered: type: boolean description: Whether the tunnel termination service has registered with Mist cloud readOnly: true tunterm_switch_config: allOf: - $ref: '#/components/schemas/mxedge_tunterm_switch_configs2' - description: Switch VLAN settings for tunnel termination versions: allOf: - $ref: '#/components/schemas/mxedge_versions2' - description: Service version information reported by the Mist Edge readOnly: true description: Mist Edge appliance configuration and registration state 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