11-10-2020 10:58 PM
I am looking for the official Rest API documentation to get the correct syntax to configure devices via PUT command.
I am looking for something like this API Explorer but for Cisco switches:
https://dropbox.github.io/dropbox-api-v2-explorer/#file_properties_properties/update
I do get some URLs while GETting configurations from my device (Catalyst 9200 switch), but all the URLs are 404:
<GigabitEthernet xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-native" xmlns:ios="http://cisco.com/ns/yang/Cisco-IOS-XE-native"> <name>1/0/17</name> <description>dontmakestupidpeoplefamous</description> <switchport> <trunk xmlns="http://cisco.com/ns/yang/Cisco-IOS-XE-switch"> <native> <vlan>225</vlan> </native> </trunk> </switchport> <source> <template> <template-name> <template-name>LAN</template-name> </template-name> </template> </source> </GigabitEthernet>
I have already seen similar questions pop up multiple times, but in all of them, the answers seem to miss the topic. This is not a question what I want to configure in detail, or what tool I use to configure it. Thses questions are irrelevant. I just want to know where i can find the API Documentation / Browser / Explorer for these devices.
Note: This is basically a repost of this post: https://community.cisco.com/t5/switching/rest-api-documentation-for-catalyst-9000-switches/m-p/4179846#M495507
Issue with cisco forum is, as soon as someone replies to a question, no matter how stupid the answer is, noone is gonna look at the question again. So please only answer if you have a clue about the topic. No quick Google searches that you might think could be the solution to this question. I have already done that, hence this topic.
Solved! Go to Solution.
07-10-2024 12:42 AM
There is a tool from cisco that gets you all documentation called the Yang Suite. In this post, there is more information about it:
https://community.cisco.com/t5/network-devices/where-to-find-api-documentation-for-9300-switch-ios-xe/m-p/5139899#M467
11-19-2020 11:12 AM
I stumbled on your question trying to find an answer to the same thing. You first have to enable RestConf and Https.
https://developer.cisco.com/docs/ios-xe/#!enabling-restconf-on-ios-xe/restconf
12-03-2020 12:43 AM
And we have another post that did not read the question. WHERE IS THE API DOCUMENTATION?
If i ever stumble onto any documentation, i will post a link to it here. If you dont see any other post, i would just guess that cisco deliberatly does not provide documentation to the API to make it difficult to develop your own tools. I guess they just want to sell you the expensive DNA center. Thats one way to do it. A **bleep**ty way, but it is a way...
07-10-2024 12:42 AM
There is a tool from cisco that gets you all documentation called the Yang Suite. In this post, there is more information about it:
https://community.cisco.com/t5/network-devices/where-to-find-api-documentation-for-9300-switch-ios-xe/m-p/5139899#M467
Discover and save your favorite ideas. Come back to expert answers, step-by-step guides, recent topics, and more.
New here? Get started with these tips. How to use Community New member guide