Creates a new Cisco Umbrella Integration.
Before you begin:
- Ensure you have generated an API Key and API Secret Key from the Cisco Umbrella
Dashboard. For more information, refer to the Cisco Umbrella documentation.Attention:
- BlueCat Edge v25.2 does not support Cisco Umbrella Legacy API Keys. To use the Cisco Umbrella integration, you must generate new Cisco Umbrella API keys.
- When creating the API Key and API Secret Access Key from the Cisco Umbrella Dashboard, you must select the Umbrella Network Devices option on the What should this API do? page.
- Retrieve the Organization ID from the Cisco Umbrella Dashboard. This is used to
verify that the Cisco Umbrella integration has been successfully configured. The
Organization ID is denoted in the URL of the Cisco Umbrella Dashboard:
https://dashboard.umbrella.com/o/{organizationId}/#/overview
Request: POST https://api-<BlueCat.edge.url>/v1/api/umbrellaIntegrations
Authorization: Bearer authorization token
Content-Type: Application/JSON
{
"name": "<name of integration>",
"description": "<description of integration">,
"organizationId": <organization id>,
"networkDeviceCredentials": {
"key": "<api key>",
"secret": "<api secret key>"
}
}Response
201 CREATED
Headers: Location:v1/api/umbrellaIntegrations/{id}Successful response code:
- CREATED - Successful request
Possible error codes:
- BAD REQUEST - Invalid request
- CONFLICT - An integration already exists
- INTERNAL SERVER ERROR - Unexpected error