dkschruteBeets / Pax8-API

A PowerShell Module for the Pax8 REST API

Pax8 REST API

A PowerShell Module for the Pax8 REST API
Explore the docs »

Report Bug · Request Feature

About

This project exists to streamline Pax8 interactions and provide a way to automate tasks within the platform.

Getting Started

The Pax8 REST API requires a Developer Application to authenticate and make requests. This provides a client_id and client_secret which is used in this module to connect to the API.

For more information, please refer to the Pax8 documentation.

Installation

Install-Module -Name 'Pax8-API'

Usage

Run the initial connect command:

Connect-Pax8 -credential <client_id>

For a complete list of commands, please refer to the documentation.

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/CoolFeature)
3. Commit your Changes (git commit -m 'Add some CoolFeature')
4. Push to the Branch (git push origin feature/CoolFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Acknowledgments

• Animals as Leaders - Many hours were spent listening to these guys while working on this project. 🎶
• christaylorcodes - I drew a ton of inspiration from his ConnectWise module. Good stuff. 🤘
• ... and of course, Dwight Kurt Schrute III 🐻