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

Cisco Umbrella Organization Tunnel API

The Organization Tunnel API from Cisco Umbrella — 4 operation(s) for organization tunnel.

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

This API exposes 7 operations across 4 paths, and defines 16 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}.

7 operations 4 paths 16 schemas 1 DELETE3 GET2 POST1 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 Organization Tunnel API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauthFlow) using the clientCredentials flow, exposing 3 scopes. By default, every request must be authenticated.

  • oauthFlow — client credential flow

Paths & Operations 7

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

Organization Tunnel 7
GET
/tunnels
List Tunnels
listTunnels 4 params → 200400401403404500
POST
/tunnels
Create Tunnel
addTunnel body → 200400401403404500
GET
/tunnels/{id}
Get Tunnel
getTunnel 1 param → 200400401403404500
PUT
/tunnels/{id}
Update Tunnel
updateTunnel 1 param body → 200400401403404500
DELETE
/tunnels/{id}
Delete Tunnel
deleteTunnel 1 param body → 200400401403404409500
POST
/tunnels/{id}/keys
Update and Rotate Tunnel Credentials
updateTunnelCredentials 1 param body → 200400401403404500
GET
/tunnels/{id}/policies
List Policies for Tunnel
getTunnelPolicies 4 params → 200400401403404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TunnelResourceObject (11 properties), TunnelResourceObjectWithState (11 properties), TunnelResourceObjectWithSecret (11 properties), parametersWithSecret (3 properties). Each schema is shown below with its type and property counts.

parametersWithSecret
object
3 properties
authentication
object
The authentication context of the client.
2 properties
ikeState
string
IKE SA State: CREATED CONNECTING ESTABLISHED PASSIVE REKEYING REKEYED DELETING DESTROYING
secretParameter
string
The secret of the PSK credentials. Ensure that you save the secret. The secret is not provided at any other time.
TunnelResourceObjectWithSecret
object
The properties of the tunnel resource object.
11 properties
parameters
object
2 properties
serviceType
string
The type of service to associate with the tunnel. The default value is SIG.
modifiedAt
string
The data and time (timestamp) when the tunnel was updated.
authenticationWithSecret
object
The authentication context of the client.
2 properties
TunnelResourceObject
object
The tunnel resource object.
11 properties
TunnelResourceObjectWithState
object
Get the information about the tunnel in the organization. To include the tunnel state information in the response, set the includeState request query parameter…
11 properties
networkCIDRs
array
Enter IPv4 ranges and CIDR addresses. If serviceType is SIG, add all public and private address ranges used internally by your organization. Overrides Umbrella…
deviceType
string
The type of device where the tunnel originates. The default value is other.
TunnelClientMetadataWithSecret
object
The tunnel client's configuration metadata including the client secret.
2 properties
TunnelClientMetadata
object
The tunnel client's configuration metadata.
2 properties
ipsecState
string
IPSec/Child SA State: CREATED ROUTED INSTALLING INSTALLED UPDATING REKEYING REKEYED RETRYING DELETING DELETED DESTROYING

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-umbrella-organization-tunnel-api-openapi.yml Raw ↑

Other APIs Cisco Umbrella publishes across the network.

Cisco Umbrella Activities API
Cisco Umbrella Activity API
Cisco Umbrella API Keys API
Cisco Umbrella API Usage Report API
Cisco Umbrella Application Categories API
Cisco Umbrella Application Lists API
Cisco Umbrella Applications API
Cisco Umbrella Apps API
Cisco Umbrella AS Information for a Domain API
Cisco Umbrella Bandwidth by Hour API
Cisco Umbrella Bandwidth by Timerange API
Cisco Umbrella Cisco Secure Malware Analytics Integration API
Where this information came from

This is an independent, third-party profile of Cisco Umbrella Organization Tunnel 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.