Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

To allow programmatic access to information on devices in your tenant UDM Pro has a Rest API from v2.1.0 onwards.

...

Once you have an access token you can then request data using a GET request. Add the access token to your request headers:

...

Code Block
languageactionscript3
titleExample Request Header
Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiGfdWRtYWRtaW4iLCJyb2xlcyI6WyJST0xFS0FETUlOIl0sImV4cCI6YTU4NTEzMTI2NCwiaWF0IjoxNTg0NTI2NDY0fQ.RJ2MmrSIifoJTUPy3InMm_z3fAoZibCBVxcSSYA8Zhs

...

  • format - json (default), csv
  • search (column content) - search=[location_name=HQ, mac_address=000*] * in search is wild card
  • columns - columns=[mac_address,ip_address,model,user_contact] – The MAC address is always returned even if it is not specified in the list of columns.
  • orderBy (column name)
  • take - Take the first xx results returned. Example return the first 10 results; take=10
  • skip - Skip the yy results returned and take the next xx. Example skip the first 40 results and return the next 20; skip=40&take=20

...