A simple python application that queries the Paramify API and returns the results in an HTML web application. The goal is to provide a jump start to using the Paramify API and help you understand the available API endpoints and response JSON structure.
Watch the full walkthrough video: Loom Video | Download Video (MP4)
The video covers how to create an API key in your Paramify workspace, install and run the tool locally using Python/Flask, and navigate the available endpoints for projects, controls, issues, and more.
Video Chapters:
- 0:00 - Introduction
- 0:53 - Creating an API key in Paramify
- 1:28 - Installing and running the tool locally
- 2:53 - Accessing full Swagger API documentation
-
This assumes you have Python installed on your local machine.
-
Clone the repository:
git clone https://github.com/paramify/paramify-api-browser.git cd paramify-api-browser -
Install the required libraries:
pip3 install -r requirements.txtThis installs Flask, Flask-Session, and requests.
-
Start the server:
python3 server.py -
Open a browser to http://localhost:3000
-
Login with your Paramify API credentials:
- Select your environment from the dropdown (Production, Demo, or Stage)
- Enter your Bearer token
-
Click the buttons to call the APIs.
The Paramify REST API uses Bearer token authentication. You'll need:
- Environment: Select from Production (app.paramify.com), Demo (demo.paramify.com), or Stage (stage.paramify.com)
- API Token: Your Bearer token for authentication
The base API URL will automatically be set based on your environment selection. You can also manually edit the URL if needed.
To create a Paramify API Key, see the Create a Paramify API Key guide.
The full Paramify API documentation is available at: https://app.paramify.com/api/documentation/#/
This API Browser example was inspired by and adapted from the SentinelOne API Browser. We're grateful to SentinelOne, our partner and friends, for their example and open-source contribution.