{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Orgs MxEdges API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Orgs MxEdges",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "listOrgMxEdges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "for_site",
                "value": "",
                "type": "query",
                "description": "Filter for org/site level Mist Edges. enum: `any`, `false`, `true`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Select the page number to return when using page-based pagination; starts at `1`"
              }
            ]
          },
          "docs": "List Mist Edge appliances in the organization, optionally filtering for org-level, site-level, or all Mist Edges with `for_site`."
        },
        {
          "info": {
            "name": "createOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Mist Edge appliance configuration in the organization, including cluster assignment, management, services, and tunnel termination settings."
        },
        {
          "info": {
            "name": "assignOrgMxEdgeToSite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/assign",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign one or more Mist Edge appliances from the organization to a site by Mist Edge ID and site ID."
        },
        {
          "info": {
            "name": "claimOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/claim",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Claim one or more Mist Edge appliances into the organization using their claim codes."
        },
        {
          "info": {
            "name": "countOrgMxEdges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/count",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `distro`, `model`, `mxcluster_id`, `site_id`, `tunterm_version`"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "query",
                "description": "Filter results by Mist Edge identifier"
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Mist edge site id"
              },
              {
                "name": "mxcluster_id",
                "value": "",
                "type": "query",
                "description": "Mist edge cluster id"
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Filter results by device model"
              },
              {
                "name": "distro",
                "value": "",
                "type": "query",
                "description": "Debian code name (buster, bullseye)"
              },
              {
                "name": "tunterm_version",
                "value": "",
                "type": "query",
                "description": "Filter results by tunnel termination version"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Field used to sort results"
              },
              {
                "name": "stats",
                "value": "",
                "type": "query",
                "description": "Whether to return device stats, default is false"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              }
            ]
          },
          "docs": "Count organization Mist Edge records, optionally grouped by `distinct` and filtered by Mist Edge, cluster, site, model, distro, tunnel termination version, and time range."
        },
        {
          "info": {
            "name": "countOrgSiteMxEdgeEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/events/count",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "distinct",
                "value": "",
                "type": "query",
                "description": "Field used to group this count response. enum: `mxcluster_id`, `mxedge_id`, `package`, `type`"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "query",
                "description": "Filter results by Mist Edge identifier"
              },
              {
                "name": "mxcluster_id",
                "value": "",
                "type": "query",
                "description": "Mist edge cluster id"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter results by service name"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              }
            ]
          },
          "docs": "Count Mist Edge event records across the organization, optionally grouped by `distinct` and filtered by Mist Edge, cluster, event type, service, and time range."
        },
        {
          "info": {
            "name": "searchOrgMistEdgeEvents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/events/search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "query",
                "description": "Filter results by Mist Edge identifier"
              },
              {
                "name": "mxcluster_id",
                "value": "",
                "type": "query",
                "description": "Mist edge cluster id"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "See [List Device Events Definitions](/#operations/listDeviceEventsDefinitions)"
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter results by service name"
              },
              {
                "name": "component",
                "value": "",
                "type": "query",
                "description": "Filter results by component name"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "On which field the list should be sorted, -prefix represents DESC order"
              },
              {
                "name": "search_after",
                "value": "",
                "type": "query",
                "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
              }
            ]
          },
          "docs": "Search Mist Edge event records across the organization with filters for Mist Edge, cluster, event type, service, component, and time range."
        },
        {
          "info": {
            "name": "searchOrgMxEdges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "hostname",
                "value": "",
                "type": "query",
                "description": "Partial / full Device hostname. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `my-london*` and `*london*` match `my-london-1`). Suffix-only wildcards (e.g. `*london-1`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "query",
                "description": "Filter results by Mist Edge identifier. Accepts multiple comma-separated values."
              },
              {
                "name": "mxcluster_id",
                "value": "",
                "type": "query",
                "description": "Mist edge cluster id. Accepts multiple comma-separated values."
              },
              {
                "name": "model",
                "value": "",
                "type": "query",
                "description": "Partial / full Device model. Use `prefix*` for prefix search or `*substring*` for contains search (e.g. `AP4*` and `*P4*` match `AP43`). Suffix-only wildcards (e.g. `*43`) are not supported. Accepts multiple comma-separated values."
              },
              {
                "name": "distro",
                "value": "",
                "type": "query",
                "description": "Debian code name (buster, bullseye)"
              },
              {
                "name": "tunterm_version",
                "value": "",
                "type": "query",
                "description": "Filter results by tunnel termination version"
              },
              {
                "name": "site_id",
                "value": "",
                "type": "query",
                "description": "Mist edge site id"
              },
              {
                "name": "stats",
                "value": "",
                "type": "query",
                "description": "Whether to return device stats, default is false"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "On which field the list should be sorted, -prefix represents DESC order"
              },
              {
                "name": "search_after",
                "value": "",
                "type": "query",
                "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed."
              }
            ]
          },
          "docs": "Search organization Mist Edge records with filters for hostname, Mist Edge, cluster, site, model, distro, tunnel termination version, and time range."
        },
        {
          "info": {
            "name": "unassignOrgMxEdgeFromSite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/unassign",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unassign one or more Mist Edge appliances from their current site while keeping them in the organization."
        },
        {
          "info": {
            "name": "getOrgMxEdgeUpgradeInfo",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/versions",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Upgrade channel used to filter available versions. enum: `alpha`, `beta`, `stable`"
              },
              {
                "name": "distro",
                "value": "",
                "type": "query",
                "description": "Filter results by distro"
              }
            ]
          },
          "docs": "Retrieve available Mist Edge package versions by upgrade channel and distro."
        },
        {
          "info": {
            "name": "getOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve configuration and registration details for a specific Mist Edge appliance in the organization."
        },
        {
          "info": {
            "name": "updateOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Mist Edge appliance configuration, including model, name, management IP, services, and tunnel termination settings."
        },
        {
          "info": {
            "name": "deleteOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a Mist Edge appliance record from the organization by Mist Edge ID."
        },
        {
          "info": {
            "name": "addOrgMxEdgeImage",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/image/:image_number",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "image_number",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Upload and attach an image file to a Mist Edge appliance. A Mist Edge can have up to three image attachments."
        },
        {
          "info": {
            "name": "deleteOrgMxEdgeImage",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/image/:image_number",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "image_number",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a numbered image attachment from a Mist Edge appliance."
        },
        {
          "info": {
            "name": "restartOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/restart",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Restart the registration workflow for a Mist Edge replacement by disconnecting the currently registered appliance so another Mist Edge can register."
        },
        {
          "info": {
            "name": "bounceOrgMxEdgeDataPorts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/tunterm/bounce_port",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bounce one or more TunTerm data ports on a Mist Edge, optionally setting the hold time between port bounces."
        },
        {
          "info": {
            "name": "disconnectOrgMxEdgeTuntermAps",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/tunterm/disconnect_aps",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Disconnect specific APs from the Mist Edge TunTerm service by AP MAC address."
        },
        {
          "info": {
            "name": "controlOrgMxEdgeServices",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/services/:name/:action",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "enum: `mxagent`, `mxdas`, `mxnacedge`, `mxocproxy`, `radsecproxy`, `tunterm`"
              },
              {
                "name": "action",
                "value": "",
                "type": "path",
                "description": "Restart or start or stop"
              }
            ]
          },
          "docs": "Start, stop, or restart a named Mist Edge service such as `tunterm`, `mxagent`, or `radsecproxy`."
        },
        {
          "info": {
            "name": "uploadOrgMxEdgeSupportFiles",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/support",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Trigger upload of support files from a Mist Edge for troubleshooting."
        },
        {
          "info": {
            "name": "unregisterOrgMxEdge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/unregister",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Unregister a Mist Edge during a replacement workflow by disconnecting the currently registered appliance so another Mist Edge can register."
        },
        {
          "info": {
            "name": "getOrgMxEdgeVmParams",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/mxedges/:mxedge_id/vm_params",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mxedge_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve VM deployment parameters for a Mist Edge, including model, optional name, and base64 user data."
        }
      ]
    }
  ],
  "bundled": true
}