Provides step-by-step instructions for obtaining a Cisco API key, outlining the required procedures and prerequisites to enable authorized access to Cisco SD-WAN Cloud APIs.
Enable authorized access to Cisco SD-WAN Cloud APIs by generating and collecting all necessary credentials and endpoint details.
The Cisco SD-WAN Cloud Release 20.15 (and later) lets you generate a personal API key, find your API gateway URL, organization name, and obtain a cross-site request forgery (CSRF) token—all prerequisites for making secure authorized API calls.
Before you begin
-
Ensure you have access to your Cisco SD-WAN Cloud fabric with an account for which you can view My Profile.
-
Make sure you have administrative privileges, if required, to generate API tokens or view organizational settings.
Follow these steps to obtain your Cisco API key and all related authentication values:
Procedure
-
Log in to your SD-WAN Cloud fabric.
-
Select My Profile from the drop-down menu under your user ID.
-
Obtain your API key (also called API token).
- In Cisco SD-WAN Manager click your user name at the top of the page, and choose My profile.
- In the API token area, click Generate.
The system generates and displays the API key.
- Copy the API key, or download it.
-
Obtain your organization name.
- Open .
- Copy the name from the Organization name field.
-
Obtain your API gateway URL.
Use the endpoint information provided. In the payload, use the organization name for 'org' and the API key for 'apikey'.
Example:
Post
https://ssp.sdwan.cisco.com/ssp/api/v6/apigw/info/
Payload
{
"org": "kdk...",
"apikey": "eyJ0eX...",
"is_redirect": false
}
Response
{
"gateway_url": "apigw1clouduswest2-1024.viptela.info",
"org": "kdk..."
}
Note
If the response is not successful, a new API gateway might have been provisioned near your location. Start a new process to connect to the newly provisioned gateway for your overlay.
You receive the API Gateway URL in the response.
-
Obtain your cross-site request forgery (CSRF) token.
Using the API key and gateway URL hostname values you received, make a GET request to the endpoint “/dataservice/client/token” to obtain the CSRF token.
You receive the CSRF token in the response.
You have collected your API key, organization name, gateway URL, and CSRF token—everything needed to authenticate and make secure API calls.
What to do next
Use the information you have obtained to make API calls. Note that some API calls, such as PUT and POST, require the CSRF token.