topic Re: DNAC API - User Defined Fields in Network Platform API

DNAC API - User Defined Fields

Nik1709 — Tue, 26 Apr 2022 08:48:52 GMT

Hi everyone,

Since the DNAC Sandboxes are currently all reserved and i cannot test it myself i thought i might just ask in here...

Does someone know if I can query user defined fields from specific devices via the DNAC API ?

So basically i can create my own data fields in the Web GUI and now i would like to know if an API Call like "get-device by ID" or "get-device-details" will also list those user defined fields.

Thanks in advance!

Kind regards, Niklas.

Re: DNAC API - User Defined Fields

barry.cronin@workday.com — Tue, 17 May 2022 10:00:38 GMT

Hi @Nik1709 did you resolve this issue. I'd also like to see if I can query for user defined fields.

Re: DNAC API - User Defined Fields

Nik1709 — Tue, 17 May 2022 10:41:51 GMT

Hi @barry.cronin unfortunately I was not able to resolve this topic. I think it is just not possible natively with the DNAC API.

Re: DNAC API - User Defined Fields

ao1 — Tue, 17 May 2022 21:10:51 GMT

Hey @Nik1709, barry.cronin@workday.com,

After a quick look I don't see any endpoint in the official API documentation that would allow this. If you know the device's UUID, you can query its user-defined fields via a GET request to the endpoint "/network-device/{{ uuid }}/user-defined-field". This endpoint will return JSON as follows:

{"response": [{"name": "testfield", "value": "pleaseignore"}, {"name": "testfield2", "value": "alsoignore"}], "version": "1.0"}

This was tested in DNAC version 2.2.3.5. Hope this is of any use.

Re: DNAC API - User Defined Fields

Nik1709 — Wed, 18 May 2022 06:05:02 GMT

Hi @ao1 thank you very much.

After testing I can confirm that this API call works just fine.

Just out of curiosity, how do you know the call ? As you mentioned as well the api docs do not mention any user-defined-field calls at all.

Best Regards

Nik

Re: DNAC API - User Defined Fields

barry.cronin@workday.com — Wed, 18 May 2022 14:55:42 GMT

I tried this and it worked really well. Thank you.

Re: DNAC API - User Defined Fields

ao1 — Thu, 19 May 2022 18:13:57 GMT

Glad it worked!

DNAC has many undocumented/ internal API endpoints it uses to translate what you do in the GUI. You can see them by using the "network" tab in the web developer submenu in your browser.