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 API Keys API

The API Keys API from Cisco Umbrella — 3 operation(s) for api keys.

Documentation Provider Profile APIs.io OpenAPI GitHub

Cisco Umbrella API Keys 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 APIKeys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 19 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}.

6 operations 3 paths 19 schemas 1 DELETE2 GET1 PATCH2 POST

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 API Keys 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 — client credential flow

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

API Keys 6
GET
/apiKeys
List API Keys
getAPIKeys 2 params → 200401403503default
POST
/apiKeys
Create API Key
createAPIKeys body → 201401403409415503default
GET
/apiKeys/{apiKeyId}
Get API Key
getAPIKey 1 param → 200401403404503default
DELETE
/apiKeys/{apiKeyId}
Delete API Key
deleteAPIKey 1 param → 204401403404503default
PATCH
/apiKeys/{apiKeyId}
Update API Key
patchAPIKey 1 param body → 200401403404415503default
POST
/apiKeys/{apiKeyId}/refresh
Refresh API Key
refreshApiKey 1 param → 200401403404415503default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are KeyWithSecret (15 properties), KeyRefreshSecret (14 properties), Key (14 properties), KeyForList (13 properties). Each schema is shown below with its type and property counts.

lastRefreshedAt
string
The date and time when the key was last refreshed, specified in the ISO 8601 format.
clientSecret
string
The client secret. The client secret is used with the client ID to attain a token for making API calls.
createdAt
string
The date and time when the key was created, specified in the ISO 8601 format.
KeyForList
object
The API key information.
13 properties 9 required
Key
object
The API key information.
14 properties 9 required
creatorEmail
string
The email address of the user who created the key.
creatorKeyId
string
The ID of the KeyAdmin key that generated the key.
description
string
The text that describes the purpose of the API key.
allowedIPs
array
The list of public IP addresses and CIDR blocks that can make API requests with the API key.
lastUsedAt
string
The date and time when the key was last used, specified in the ISO 8601 format.
clientId
string
The client ID associated with the API key. The client ID is used with the client secret to attain a token for making API calls.
expireAt
string
The date and time when the key is set to expire. The timestamp is specified as an ISO 8601 formatted string, or an empty string (''). An empty string indicates…
creatorName
string
The name of the user who created the key.
modifiedAt
string
The date and time when the key was updated, specified in the ISO 8601 format.
KeyWithSecret
object
The API key information including the client id and secret.
15 properties 11 required
KeyRefreshSecret
object
The API key information including the client id and secret.
14 properties 11 required
scopes
array
A list of scopes and permissions attached to the API key.
id
string
A unique identifier for the key.
name
string
The unique descriptive label for the API key.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-umbrella-api-keys-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 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
Cisco Umbrella Cnames API
AE Profile APIs.io
#APIKeys
← Back to C APIs
API Details
ID
cisco-umbrella:cisco-umbrella-api-keys-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-api-keys-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cisco-umbrella-api-keys-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 API Keys 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.