We are very excited to announce General Availability (GA) of the Umbrella Open APIs. Our revamped APIs offer customers an intuitive experience that makes it simple to rapidly leverage our rich collection of APIs. This new release provides user friendly access for organizations to implement their integration and orchestration use cases.
Unlike APIs with very basic controls around access and usability, the new Umbrella Open APIs offer you the ability to access a flexible and broad collection of APIs with highly customizable API keys.
The following table compares our legacy APIs with the new Umbrella API’s:
|
Before |
After |
|
API keys are predefined in terms of what they can access |
Tailored access controls for API Keys |
|
A different authentication method is needed depending on the API being used |
Unified Authentication: one method of authentication for Management, Network Devices and Reporting APIs |
|
An org can only have 1 API key per type |
Create multiple API keys and-Give them meaningful names |
|
API keys are static |
You can set expiration dates for your API Keys |
The new Umbrella Open APIs enable organizations to easily generate workflows aggregating Umbrella’s industry leading visibility with Cisco SecureX as well as other solutions to enrich cross product data and automate incident response. Get started with the new Umbrella Open API today!
Umbrella Open API FAQ
1) What can I do with these new keys?
You can create multiple credentials to access Umbrella APIs as shown in the screenshot below:
2) How can I decide what these keys can access?
By choosing the Key Scopes for them. These are arranged within 4 Use Case groups (Admin, Deployments, Reports and Policies).
3) Can I set an expiration for these new keys?
Yes, their default will be to never expire but you can specify an expiration date:
4) Will my old keys still work?
Sure! You can find them under the Legacy Keys card.
5) How long will the previous APIs keep on working for?
We have set the End Of Life for these to the 1st of September 2023. That should give everyone a chance to migrate to these new ones.
6) Where can I find the SCIM API Keys?
Under the Static Keys Card
7) Where can I find the tech docs for the Umbrella Open API?
Right here.
8) Do we still have docs for the old APIs?
Yes – under the Legacy section.
9) Do you have any examples?
Sure. We have samples for you in the Cloud Security repo.