cortex-xpanse-python-sdk

Python SDK for Cortex™ Xpanse
python3
cortex
api
sdk-python
sdk
xpanse

Xpanse Python SDK

.. image:: https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/blob/main/docs/_source/_static/xpanse_banner.png?raw=true :width: 800 :target: https://expanse.co/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8-blueviolet :target: https://pypi.python.org/pypi/xpanse

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. image:: https://img.shields.io/pypi/l/xpanse :target: https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/blob/main/LICENSE

.. image:: https://img.shields.io/github/contributors/PaloAltoNetworks/cortex-xpanse-python-sdk :target: https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/graphs/contributors

Overview

This library is intended to be an interface to the Xpanse Expander API <https://knowledgebase.xpanse.co/expander-apis/>_.

Install

.. code-block:: python

pip install xpanse

Requirements

Python 3.6+

Usage

Documentation <https://cortex-xpanse-python-sdk.readthedocs.io/en/latest/>_

.. code-block:: python

# Import client
from xpanse.client import ExClient

# initialize client
client = ExClient()

# get ip_range iterator object and dump to a list
ranges = client.assets.ip_range.list().dump()

You can view more example code in the examples <https://github.com/PaloAltoNetworks/cortex-xpanse-python-sdk/tree/main/examples>_ directory.

Configuration

A valid Client ID and Secret is required for use. This is recommended over using a JWT, as they have limited lifespans. While a bearer token is supported in this version, this auth flow is being deprecated. Therefore, it is highly recommended to use Client Credentials.

RECOMMENDED


You can supply them as environment variables using the variable names XPANSE_CLIENT_ID AND XPANSE_CLIENT_SECRET.

.. code-block:: python

export XPANSE_CLIENT_ID=<Client ID>
export XPANSE_CLIENT_SECRET=<Client Secret>

NOT RECOMMENDED


To use a short lived JWT, you can supply the JWT as an environmental variable using the name XPANSE_JWT_TOKEN

.. code-block:: python

export XPANSE_JWT_TOKEN=<JWT>

[Deprecated] A valid Bearer token can be supplied as an environment variable

To supply a valid bearer token as an environment variable, you can use the variable names XPANSE_BEARER_TOKEN.

.. code-block:: python

export XPANSE_BEARER_TOKEN=<Bearer Token>

Logging

Logging is handled through the python logging package. To enable different levels of verbosity in your scripts you can do the following:

.. code-block:: python

import logging
logging.basicConfig(level=logging.DEBUG)

You can read more at <https://docs.python.org/3/library/logging.html>_.

Developer Sites

Social


Copyright © 2022 Palo Alto Networks, Inc. All rights reserved.