How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cisco Umbrella

Cisco Umbrella Providers API

The Providers API from Cisco Umbrella — 14 operation(s) for providers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Cisco Umbrella Providers API is one of 85 APIs that Cisco Umbrella publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Providers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 14 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.umbrella.com/{basePath}.

19 operations 14 paths 36 schemas 1 DELETE10 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.umbrella.com/admin/v2
Authentication
OAuth 2.0
Contact
Cloud Security Developer Community
Resource Areas
1

Authentication & Security 1

Cisco Umbrella Providers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauthFlow) using the clientCredentials flow, exposing 5 scopes. By default, every request must be authenticated.

  • oauthFlow — The client credential flow.

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 1 DELETE, 10 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Providers 19
POST
/providers/customers
Create Customer for Provider
createProviderCustomer body → 200400401403404500
GET
/providers/customers
List Customers for Provider
listProviderCustomers 2 params → 200400401403404500
GET
/providers/customers/{customerId}
Get Customer for Provider
getProviderCustomer 1 param → 200400401403404500
DELETE
/providers/customers/{customerId}
Delete Customer for Provider
deleteProviderCustomer 1 param → 204400401403404500
PUT
/providers/customers/{customerId}
Update Customer for Provider
updateProviderCustomer 1 param body → 200400401403404500
PUT
/providers/customers/{customerId}/trialconversions
Update Trial to Customer
putTrialConversions 1 param body → 200400401403404500
POST
/providers/customers/{customerId}/accessRequests
Create Customer Access Request
createCustomerAccessRequest 1 param → 200400401403404500
GET
/providers/customers/{customerId}/accessRequests/{accessRequestId}
Get Customer Access Request
getCustomerAccessRequest 2 params → 200400401403404500
PUT
/providers/customers/{customerId}/accessRequests/{accessRequestId}
Update Customer Access Request
updateCustomerAccessRequest 2 params → 200400401403404500
POST
/providers/customers/{customerId}/trialExtensions
Create Customer Trial Extensions
createCustomerTrialExtensions 1 param body → 200400401403404500
GET
/providers/customers/{customerId}/subscriptionDetails
Get Customer Subscription Details
getCustomerSubscriptionDetails 1 param → 200400401403404500
GET
/providers/customers/{customerId}/trialStrengths
Get Customer Trial Strength
getCustomerTrialStrength 1 param → 200400401403404500
GET
/providers/customerAddresses
Get Customer Addresses for Provider
getCustomerAddresses 2 params → 200400401403404500
GET
/providers/customers/packages
Get Customer Packages for Provider
getCustomerPackages → 200400401403404500
GET
/providers/customerDeals/{dealId}
Get Customer Deals by ID
getCustomerDeals 2 params → 200400401403404500
PUT
/providers/customerDeals/{dealId}
Update Customer Deals by ID
updateCustomerDeals 1 param body → 200400401403404500
GET
/providers/consoles
Get Providers Console Data
getProvidersConsoleData → 200400401403404500
GET
/providers/customers/downloadReportRequests
Get Customer Security Report
getServiceProviderCustomerSecurityReport 1 param → 200400401403404500
POST
/providers/customers/{customerId}/securityReportRequests
Create Customer Security Report Request
createCustomerSecurityReportRequest 1 param → 200400401403404500

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are GetCustomer (32 properties), DownloadReport (28 properties), Customer (21 properties), CustomerAddress (10 properties). Each schema is shown below with its type and property counts.

GetCustomer
object
The information about the customer.
32 properties 1 required
seats
integer
The number of users.
state
string
The name of the customer's state.
packageId
integer
The ID of the Umbrella package. To create or update a customer with either the SIG Essentials or SIG Advantage package, you must have a license for the selecte…
customerName
string
The name of the customer's organization.
AccessRequest
object
The information about the organization's access request.
7 properties 4 required
streetAddress
string
The street address for the customer.
customerId
integer
The ID for the customer.
TrialStrength
object
The number of features consumed by a customer trial.
5 properties 5 required
organizationId
integer
The ID of the organization.
dealId
string
The deal ID.
packageName
string
The name of the Umbrella package. To create or update a customer with either the SIG Essentials or SIG Advantage package, you must have a license for the selec…
Customer
object
The properties of a customer.
21 properties 9 required
streetAddress2
string
The second street address for the customer.
Package
object
The information about an Umbrella package.
4 properties 4 required
CustomerDeal
object
The information about a customer deal.
5 properties 5 required
ccwDealOwnerEmails
array
The list emails for the CCW deal owner.
packageIdWrite
integer
The ID of the Umbrella package. To create or update a customer with either the SIG Essentials or SIG Advantage package, you must have a license for the selecte…
CustomerAddress
object
The customer's address information.
10 properties 3 required
city
string
The name of the city where the customer's organization is located.
PpovLifecycle
object
The email details about lifecycle events from a customer trial.
6 properties
countryCode
string
The country code of the customer's organization.
organizationName
string
The name of the customer's organization.
zipCode
string
The zip code of the customer's organization.
packageIdTrialConversions
integer
| Package Id | Package Name | |:----------:|----------------------------------| | 246 | Umbrella DNS Security Essentials | | 248 | Umbrella DNS Security Advant…
adminEmails
array
The list of the administrator email addresses.
ProvidersConsole
object
7 properties 7 required
ServerError
object
Error- This request could not be processed by the server
3 properties
sigQuestionnaire
string
The SIG questionnaire
ForbiddenError
object
Forbidden- The token is invalid
3 properties
BadRequestError
object
Validation Error
4 properties
DownloadReport
object
28 properties 1 required
NotFoundError
object
Not Found- A resource specified in the URL was not found
3 properties
PpovLifecycle_2
object
The email details for a customer trial lifecycle events
6 properties
SecurityReportsRequest
object
3 properties 2 required
UnauthorizedError
object
Unauthorized- The authorization header is missing or the token is unauthorized
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-umbrella-providers-api-openapi.yml Raw ↑

Other APIs Cisco Umbrella publishes across the network.

Cisco Umbrella Activities API
AE Profile APIs.io
Cisco Umbrella Activity API
AE Profile APIs.io
Cisco Umbrella API Keys API
AE Profile APIs.io
Cisco Umbrella API Usage Report API
AE Profile APIs.io
Cisco Umbrella Application Categories API
AE Profile APIs.io
Cisco Umbrella Application Lists API
AE Profile APIs.io
Cisco Umbrella Applications API
AE Profile APIs.io
Cisco Umbrella Apps API
AE Profile APIs.io
Cisco Umbrella AS Information for a Domain API
AE Profile APIs.io
Cisco Umbrella Bandwidth by Hour API
AE Profile APIs.io
Cisco Umbrella Bandwidth by Timerange API
AE Profile APIs.io
Cisco Umbrella Cisco Secure Malware Analytics Integration API
AE Profile APIs.io
#Providers
← Back to C APIs
API Details
ID
cisco-umbrella:cisco-umbrella-providers-api
Base URL
https://api.umbrella.com/admin/v2
Docs
https://developer.cisco.com/docs/cloud-security/umbrella-api-reference-admin-overview/
Provider
Cisco Umbrella
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cisco-umbrella-providers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cisco-umbrella-providers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cisco Umbrella Providers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.