updateOrgMxEdge
Update a Mist Edge appliance configuration, including model, name, management IP, services, and tunnel termination settings.
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidRequest Body
application/json
Request Body
Mist Edge appliance configuration and registration state
Mist Edge hardware or virtual appliance model
Mist Edge cluster identifier that this appliance belongs to
uuidManagement credentials and settings for the Mist Edge
Display name of the Mist Edge
Free-form notes for the Mist Edge
Time synchronization servers used by the Mist Edge
Out-of-band management IP configuration for the Mist Edge
Network proxy settings used by the Mist Edge
List of services enabled to run on the Mist Edge
DHCP relay or server settings for Mist Tunneled VLANs
Extra routes for Mist Tunneled VLAN traffic; property key is a CIDR
IGMP snooping settings for Mist Tunneled VLANs
Tunnel termination IP configuration for the Mist Edge
Monitoring checks for tunnel termination reachability
Multicast forwarding settings for tunnel termination
IPconfigs by VLAN ID. Property key is the VLAN ID
Port configuration for tunnel termination traffic
Switch VLAN settings for tunnel termination
Response Body
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/mxedges/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "model": "ME-X1", "name": "me-gc1-01", "oob_ip_config": { "dns": [ "8.8.8.8", "1.1.1.1" ], "gateway": "10.3.172.9", "ip": "10.3.172.201", "netmask": "/24", "type": "static" }, "services": [ "tunterm" ], "tunterm_ip_config": { "gateway": "10.10.172.2", "ip": "10.10.172.201", "netmask": "/24" }, "tunterm_port_config": { "downstream_ports": [ "0" ], "separate_upstream_downstream": true, "upstream_port_vlan_id": "1010", "upstream_ports": [ "1" ] } }'{ "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" }}