Filter parameter

The filter parameter of the GET method reduces the returned data to include only those entries that match the filter criteria. Specify the filter criteria in a comma-separated list of attribute name:value pairs.

Examples:

  • Use the filter parameter to get only the static VLANS:

    GET "https://192.0.2.5/rest/v1/system/bridge/vlans?filter=type:static"
  • Use the filter parameter to get the BGP routes that have 1.1.1.1 as a peer:

    GET "https://192.0.2.5/rest/v1/system/vrfs/default/bgp_routes?filter=peer:1.1.1.1"