pritunl-api 1.0.5

Pritunl API Client for Python

Pritunl API client for Python 3

This is a simple api client written in Python 3. View example in example.py. Python 2 is not supported. You need to refer Pritunl api doc to get the idea on how to use this.

Basically this api client use almost same command like in the doc. For example:

Quick Usage

import os

from pritunl_api import Pritunl

PRITUNL_BASE_URL = os.environ.get('PRITUNL_BASE_URL')
PRITUNL_API_TOKEN = os.environ.get('PRITUNL_API_TOKEN')
PRITUNL_API_SECRET= os.environ.get('PRITUNL_API_SECRET')

pritunl = Pritunl(
    url=PRITUNL_BASE_URL,
    token=PRITUNL_API_TOKEN,
    secret=PRITUNL_API_SECRET
    )

Example

• Example 1:

  (in source) GET /server

  pritunl.server.get()
  

• Example 2:

  (in source) PUT /server/:server_id/organization/:organization_id

  pritunl.server.put(srv_id='', org_id='')
  

• Example 3:

  (in source) DELETE /user/:organization_id/:user_id

  pritunl.user.delete(org_id='', usr_id='')
  

• Example 4:

  (in source) POST /server**

  pritunl.server.post(data={
    'name': 'new server name'})
  

  * If there is data available, you must pass it through data parameter.

  * Command above works well because there are template available for creating a new server.

• Example 5:

  (in source) PUT /user/:organization_id/:user_id

  api.user.put(org_id='', usr_id='', data={
    'name': 'modified org name',
    'disabled': True})
  

Installation

pip install pritunl-api

Include REPL Tools

pip install pritunl-api[repl]

API Development

Docker Environment

Building a Development Container

docker buildx build . \
  --progress plain \
  --file dev.Dockerfile \
  --tag pritunl-api:development

Running a Development Container

docker run --rm -it \
  --volume $(PWD):/pritunl-api \
  --env-file .env \
  pritunl-api:development

---

This api client is not fully complete. There are some features missing, feel free to fork and pull request to add new features.

Tested working on Pritunl v1.30.3354.99.