@jweb-development/cisco-umbrella

Package for integrating with cisco umbrella api.

Usage no npm install needed!

<script type="module">
  import jwebDevelopmentCiscoUmbrella from 'https://cdn.skypack.dev/@jweb-development/cisco-umbrella';
</script>

README

jweb-logo

Npm package version Npm downloads Github Checks Github Status Github PRs Package Types Github Commits Github Releases Package Types MIT license

Cisco Umbrella

This package compromises a TypeScript library meant for interacting with Cisco Umbrella's API.

Installation

To install type the following:

npm i @jweb-development/cisco-umbrella
yarn add @jweb-development/cisco-umbrella

Use Case

In order to integrate our current API with Cisco Umbrella's API, we had to design a library capable of managing the integration. To achieve this, the package takes data acquired from our api to be processed by Cisco Umbrella's API. This package currently supports API integration with Enforcement, Destination Lists, Destinations, and Organizations.

Documentation

  • API

  • Examples

Contributing

Development

To run a development copy of @jweb-development/cisco-umbrella, type the following:

# First we clone the repository
git clone https://github.com/jweb-development/cisco-umbrella.git
cd cisco-umbrella

# Then we install the dependencies
npm install

# Then we build the package
npm run build

This will output the files into the dist directory.

Contributors