About the documentation

The pyexclient documentation is composed of the following sections:

  • Introduction – Brief background and description of Expel and pyexclient.
  • Getting Started – How to get started using pyexclient and walks through requesting an API key.
  • Understanding the client – Provides intuition and background on the pythonification of JSON API spec.
  • Usage and Examples – Reading this section should enable you to have an intuitive sense for how to accomplish your specific needs. A large number of example uses in this documentation can implement everything from creating and updating an investigation, to extracting all source/dest IPs associated with Expel alerts.
  • API Reference – Detailed API reference.