Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesDevicesWired

updateSiteLocalSwitchPortConfig

PUT
/api/v1/sites/{site_id}/devices/{device_id}/local_port_config

API Calls to add port config local overrides. This can be used by Switch Port Operators or Helpdesk administrators to change a Switch Port configuration without having to change the switch configuration.

The local overrides configured for the switchports with no_local_overwrite==true won't be applied to the switch configuration.

NOTE:

When using the API Call, it is required to put send all overrides in the PUT request Payload, even the existing once.

The current overrides can be retrieved with the API Call Get Site Device. The local overrides will show up separately from the port_config in the local_port_config so it can be easily identified (and cleared)

Authorization

Authorization<token>

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

site_id*string
Formatuuid
device_id*string
Formatuuid

Request Body

application/json

Per-port Switch Port Operator (SPO) override, overriding the port configuration from port_config. Property key is the port name or range (e.g. "ge-0/0/0-10")

[key: string]?

Per-port Switch Port Operator (SPO) override configuration used in local_port_config to customize settings inherited from port_config

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/local_port_config" \  -H "Content-Type: application/json" \  -d '{    "ge-0/0/0-1": {      "poe_disabled": true,      "usage": "iot"    }  }'
Empty

deleteSiteLocalSwitchPortConfig DELETE

API Calls delete all the existing port config local overrides, and reapply the configured planed at the device level (with site / template heritance).

changeSiteSwitchVcPortMode POST

Change VCP port mode Some switch model allows changing VCP port behaviors, e.g. - use them as regular network ports - change vcp protocol Note, this command will reboot the switch