API Explorer

Sample application for the Palo Alto Networks Application Framework.

Documentation: https://apiexplorer.readthedocs.io
Free software: ISC license

Features

Built-in OAuth2 support for authorizing access to Application Framework and fetching tokens.
Built on top of Palo Alto Networks Cloud Python SDK.
Logging, Event and Directory-Sync Explorers.
Sample Query Library for Logging Service.
Experiment with API requests/responses.

Status

API Explorer is considered beta at this time.

Installation

The easiest method to install API Explorer is to clone the repo to your dev machine:

$ git clone https://github.com/PaloAltoNetworks/apiexplorer.git

Use to install all dependencies and create a virtualenv for your project:

$ pipenv install

You can specify which python version to use by adding "--two" or "--three" to pipenv install or shell arguments:

$ pipenv --three install

Enter a pipenv shell:

$ pipenv shell

Run Modes

API Explorer supports three different run modes: DEFAULT, PRODUCTION and DEBUG.

DEFAULT: API Explorer listens on unix socket

Logs access and error logs to /va/log/gunicorn.

Intended to run behind NGiNX (proxypass to socket)

PRODUCTION: API Explorer listens on TCP/5000

Logs access and error logs to stdout.

Intended to run behind NGiNX (proxypass to TCP/5000).

Used in docker-compose container.

DEBUG: API Explorer listens on TCP/443

Logs debug messages and stack traces to console.

Does not require NGiNX

Runs as multi-threaded

Requires sudo privileges or port mapping

Usage

usage: run.py [-h] [-d] [-p]

Palo Alto Networks API Explorer

optional arguments:

-h, --help show this help message and exit -d, --debug Debug mode -p, --production Production mode

DEFAULT Mode (unix socket for nginx):

$ ./run.py

PRODUCTION Mode (TCP/5000):

$ ./run.py -p

or

$ ./run.py --production

DEBUG Mode (TCP/443):

$ sudo ./run.py -d

or

$ sudo ./run.py --debug

Contributors

Steven Serrata - github