Skip to main content

REST API client framework to manage the Illumio Core Policy Compute Engine

Project description


License Latest Release

Illumio Policy Compute Engine REST client for python 3. Exposes PCE API endpoints as functions through a simple interface.

Compatible with Illumio Core PCE version 21.2+.

The main entrypoint for the client is the PolicyComputeEngine class:

>>> from illumio import PolicyComputeEngine
>>> pce = PolicyComputeEngine('', port='8443', org_id='12')
>>> pce.set_credentials('api_key', 'api_secret')
>>> workloads = pce.workloads.get(
...     params={
...         'managed': True,
...         'enforcement_mode': 'visibility_only'
...     }
... )
>>> workloads
    Workload(href='/orgs/12/workloads/c754a713-2bde-4427-af1f-bff145be509b', ...),

For more information on the Illumio APIs, see the REST API guide and the API reference for your version of Illumio Core.

Read the Docs

You can find API documentation, code examples, and usage guides on our readthedocs page!


The illumio library is now available on pypi!

$ python -m pip install illumio

To build and install from source

$ git clone
$ cd illumio-py
$ make


The illumio package is released and distributed as open source software subject to the included LICENSE. Illumio has no obligation or responsibility related to the package with respect to support, maintenance, availability, security or otherwise. Please read the entire LICENSE for additional information regarding the permissions and limitations. Support is offered on a best-effort basis through the Illumio app integrations team and project contributors.


See the project's CONTRIBUTING document for details.


Copyright 2022 Illumio

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   See the License for the specific language governing permissions and
   limitations under the License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

illumio-1.1.3.tar.gz (93.5 kB view hashes)

Uploaded source

Built Distribution

illumio-1.1.3-py3-none-any.whl (59.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page