Installation

To install from a local folder execute at the ‘umbr_api’ root directory:

pip3 install -e .

To install extra requirements from a local folder execute at the ‘umbr_api’ root directory:

pip3 install -e .[dev]
pip3 install -e .[doc]
pip3 install -e .[dev_lint]

To install from production https://pypi.org execute:

pip3 install umbr_api

To install from GitHub:

pip3 install git+https://github.com/kolatz/umbr_api.git

To install from local archive:

pip3 install filename.tar.gz

Please note, that you still need register and activate API key from Cisco to enable functionality.

Use of command-line utility

main() in umbrella.py registered as umbrella executable. So, you can run it directly.

Examples:

umbrella add www.example.com http://www.example.com/images
umbrella add example.com example.com --force
umbrella del www.example.com
umbrella del 555XXXXX --key YOUR-CUSTOMER-KEY-IS-HERE-0123456789
umbrella get 100
umbrella get --key YOUR-CUSTOMER-KEY-IS-HERE-0123456789

Use API wrapper

You need to import particular functions or modules from umbr_api. For example:

from umbr_api import get
get.get_list(key='YOUR-CUSTOMER-KEY-IS-HERE-0123456789')

from umbr_api.add import add
add(domain='example.com', url='example.com', key='YOUR-CUSTOMER-KEY-IS-HERE-0123456789')

There three main functions:

• umbr_api.get.get_list

• umbr_api.add.add

• umbr_api.remove.remove

The API key should be specified via CLI, if not functions try to read it from enforcement.json within package data\ folder.

API key

umbrella del www.example.com --key YOUR-CUSTOMER-KEY-IS-HERE-0123456789

from umbr_api.get import get_list
response = get_list(key='YOUR-CUSTOMER-KEY-IS-HERE-0123456789')

import os
import umbr_api
print(os.path.abspath(umbr_api.__file__))

umbrella keyring --add YOUR-CUSTOMER-KEY-IS-HERE-0123456789
umbrella keyring --show

Supported methods

Limitations

1. Lack of documentation

2. You heed to have an Umbrella subscription or active evaluation

3. Storing API key within json file is not secure

4. Asserts will be removed with compiling to optimized byte code. This caused various protections to be removed.

5. Other methods for change or delete entities are not supported and no plans to do that

Documentation

Documentation pages based on README.rst file and docstrings. Created for educational purposes.

• http://umbr-api.readthedocs.io/en/latest/

Contribution guidelines

• https://github.com/kolatz/umbr_api

Who do I talk to

• https://github.com/kolatz/