support.umbrella.com Open in urlscan Pro
104.16.53.111  Public Scan

Form analysis
1 forms found in the DOM

GET /hc/en-us/search

<form role="search" class="search" data-search="" data-instant="true" autocomplete="off" action="/hc/en-us/search" accept-charset="UTF-8" method="get"><input name="utf8" type="hidden" value="✓"><input type="hidden" name="category" id="category"
    value="204185887">
  <input type="search" name="query" id="query" placeholder="Search" autocomplete="off" aria-label="Search">
</form>

Text Content

Dashboard Submit a request Sign in
 1. Cisco Umbrella
 2. Service Updates
 3. Announcements




ARTICLES IN THIS SECTION

 * Support for Umbrella roaming clients and user attribution (Azure AD, OKTA,
   JAMF Connect)
 * [Action Required] DNS Content Categories migration deadline extended to
   October 28, 2022
 * Network and Tunnel Identities for AnyConnect Users is now available
 * End of Life for IP Layer Enforcement Feature of the Umbrella Roaming Client.
 * Reserved IP is now Generally Available and New Egress Information in Activity
   Search
 * Cisco Secure Client Launch and FAQs
 * Cisco Umbrella FAQ Regarding IP-Based Geo-Blocking
 * Umbrella Virtual Appliance and Active Directory Connector: Download and
   deploy
 * Support model for Umbrella Virtual Appliance and Active Directory Connector
 * Attention - Customers using Unmanaged Mobile Device protection

See more


THE UMBRELLA REPORTING APIV1 WILL BE END OF LIFE ON MARCH 31, 2022

chkovacs
 * 4 months ago
 * Updated

Follow

All customers must update to the Reporting APIv2 by this date: March 31,
2022. The APIv1 will be disabled after the EOL date. Customers who do not update
by the EOL date will find that the APIv1 is unresponsive, due to having been
disabled. We encourage all customers to fully adopt the APIv2 in a timely manner
to avoid any disruption to their use of Umbrella Reporting via the API.

Why are we making this change?

To stay ahead of the ever-changing landscape of threats and malicious events
that customers face every day, the Umbrella team continuously improves the
Umbrella service by relying on inputs from our customers, their security
operations teams, and industry best practices.

Toward that end, we released our Umbrella Reporting APIv2 over a year ago with
improvements over the Umbrella Reporting APIv1.

The Reporting APIv2 represents a complete rethink of searching and filtering
capabilities. Queries are no longer limited to one-to-one matching. There are
now over 30 endpoints with the Reporting APIv2, where the APIv1 offered 3. And
the APIv2 empowers access to information faster and in new and innovative ways,
ultimately shortening query cycles.

How do I adopt the Reporting APIv2?

First, check and see whether you are still using Reporting APIv1. In the
Reporting API queries, you can identify the currently used version and implement
the new reporting API calls following the code examples below.

Since the Reporting APIv2 expands significantly upon APIv1, the following
example APIv2 endpoints are not indicated as exact 1-for-1 replacements of
APIv1. Rather these are examples to help demonstrate how to identify usage of
the APIv1.

Note how the URLs distinguish between v1 and v2.

Destinations APIv1

http://reports.api.umbrella.com/v1/organizations/{organizationID}/destinations/{destination}/activity

APIv2

https://reports.api.umbrella.com/v2/organizations/{organizationID}/activity?domains={destination}

 

Identities APIv1

 

https://reports.api.umbrella.com/v1/organizations/{orgId}/destinations/{destination}/identities

 

APIv2

 

https://reports.api.umbrella.com/v2/organizations/{orgId}/top-identities?domains={destination}

 

 

Security Activity APIv1

https://reports.api.umbrella.com/v1/organizations/<organizationId>/security-activity

 

APIv2:

https://reports.api.umbrella.com/v2/organizations/<organizationId>/activity?categories=<list
of security activities>

 

To move from the Security Activity APIv1 endpoint, start by identifying the
Security Activity categories that are significant to you using the following:

https://reports.api.umbrella.com/v2/organizations/{orgId}/categories

Then check the API calls here to update to APIv2:

https://reports.api.umbrella.com/v1/organizations/<organizationId>/security-activity

Where can I find more information?

References:

https://developer.cisco.com/docs/cloud-security/#!reporting-v2-overview

Getting started:

To get started, please see the following guide

https://developer.cisco.com/docs/cloud-security/#!reporting-v2-getting-started

V2 Endpoints:

For a list of V2 endpoints, refer to Reporting API V2 Endpoints:

https://developer.cisco.com/docs/cloud-security/#!reporting-v2-endpoints

Learning Labs:

https://developer.cisco.com/learning/modules/cisco-umbrella

Postman Examples:

https://github.com/CiscoDevNet/cloud-security/tree/master/Umbrella/PostmanExamples/ReportingAPI%20V2

 

For additional questions, please contact umbrella-support@cisco.com .

 


Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request
Return to top


RELATED ARTICLES

 * Additional Egress IP Address Range
 * Umbrella Virtual Appliance - Version 3.1
 * [Updated] Changes to Autotask PSA integration with Umbrella
 * Umbrella edge data center updates for Madrid, Dubai, and Milan
 * Web Rule-Based Policy Now GA!


COMMENTS

0 comments

Article is closed for comments.

Cisco Umbrella