HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Patch Request to update Port objects

Update one or more ports using JSON patch(es) with their UUIDs.

The following patch paths are supported for access ports for the replace operations:

  • /admin_state
  • /description
  • /downlink_switch_uuid
  • /name
  • /native_vlan
  • /pvlan_port_type
  • /speed/configure
  • /tags
  • /type
  • /ungrouped_vlans
  • /qsfp_mode
  • /vlan_group_uuids
  • /bridge_loop_detection/mode
  • /bridge_loop_detection/interval
  • /routed
  • /qos_ingress_policies
  • /qsfp_transform
  • /split_count
  • /split_speed
  • /tagged
  • /bpdu_filter
  • /bpdu_guard
  • /root_guard
  • /loop_guard
  • /tcn_guard
  • /admin_port_type
  • /rpvst_guard
  • /rpvst_filter

The following patch paths are supported for fabric ports for the replace operations:

  • /type
  • /qsfp_mode
  • /mtu
  • /qsfp_transform
  • /split_count
  • /split_speed

The following patch paths are supported for access ports for the add and remove operations:

  • /pvlan_port_type
  • /qos_ingress_policies

Notes:
Patches are applied as follows:

  • Either the update_all query parameter or uuids property in the request body object must be provided
  • If a list of uuids are provided in the request body:
    • The UUIDs must be associated with the ports
    • The matching patch in the body will be applied to all ports whose UUID is in the uuids list
    • Note that the use of the update_all query parameter and inclusion of the uuids property in the request object are mutually exclusive features.
  • split_count and split_speed are allowed only with qsfp_transform 'split'.
Language
Credentials
Header
Click Try It! to start a request and see the response here!