topic Re: How to link to specific APIs in Controllers

How to link to specific APIs

Nathan Sowatskey — Fri, 01 Mar 2019 12:33:20 GMT

I am using this API (You will need to replace the value of apic-em with what works for you):

https://apic-em/swagger#!/device-credential/getGlobalCredential

That link was obtained by copying the URL from the browser when I was looking at the API.

If I paste that link back in, though, all I see is the top level API page.

So, how can one actually link to an API in the documentation, so as to be able to explain which API one is using?

Many thanks

Nathan

Re: How to link to specific APIs

aluktuke — Mon, 14 Nov 2016 06:52:05 GMT

Hi Nathan,

The APIs can be accessed at,

https://<APIC-EM IP>/api/v1/<API>

The <API> may have some parameters that may be required or optional parameters.

You may refer to the "APIC-EM API Reference" at,

Cisco Application Policy Infrastructure Controller Enterprise Module - Programming Guides - Cisco

For example, the device credentials GET API can be accessed at,

https://<APIC-EM IP>/api/v1/global-credential?credentialSubType=CLI

"credentialSubType" being a parameter.

Hope this explains.

Thanks,

Ashutosh

Re: How to link to specific APIs

Nathan Sowatskey — Mon, 14 Nov 2016 09:11:37 GMT

Ashutosh

Many thanks for following up.

My question is about how to access the documentation for specific APIs. My question is not about using the APIs. The first two links you have provided appear to be trying to explain how to use APIs, which is not my concern here.

This link:

APIC-EM API Reference

From:

Cisco Application Policy Infrastructure Controller Enterprise Module - Programming Guides - Cisco

Leads to:

https://anypoint.mulesoft.com/apiplatform/apx/#/portals

After authentication, a list of APIs appears. A screenshot of that page is attached. As you can see from the screenshot, there is no explanation of what these APIs are. APIC-EM might be in that list somewhere, but I can't see it.

So, my question remains unanswered.

Regards

Nathan

Re: How to link to specific APIs

yawming — Mon, 14 Nov 2016 15:19:29 GMT

The right link should be in - http://devnetapic.cisco.com/.

Re: How to link to specific APIs

aradford — Mon, 14 Nov 2016 18:06:54 GMT

I think Nathan's question is how to capture these URL?

For example, I want to point some one at the Pnp-project API. I copy the following URL:

http://devnetapic.cisco.com/#!/pnp-project/getPnpSiteByRange

When I paste it into a browser, I end up at the top level swagger page, not down in the pnp-project API.

Adam