Skip to main content

A wrapper library to facilitate the access to Outline VPN as well as its Prometheus APIs on Outline VPN Servers.

Project description

Outline API

PyPI version

Outline API is a wrapper api written in python to access Outline VPN API services. Outline VPN APIs are used for Outline keys maintenance as well as for monitoring purposes. The package also provides wrappers to access Prometheus on the Outline VPN.


use pip to install the package:

pip install outline-api

Using package

import the package and cerate a management object.

from outline_api import (

apiurl = ""
apicrt = "apicert"
manager = Manager(apiurl=apiurl, apicrt=apicrt)

new_key =
if new_key is not None:

keys = get_key_numbers("", "999")

active_keys = get_active_keys("", "999")


0.0.6 (2023-02-28)

  • Add an optional label argument for new keys

0.0.5 (2021-10-29)

  • Add custom error exceptions

0.0.4 (2021-10-27)

  • Fix timeout values

0.0.3 (2021-07-30)

  • Fix return values in case of error

0.0.1 (2020-08-01)

  • First version

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

outline-api-0.0.6.tar.gz (19.1 kB view hashes)

Uploaded source

Built Distribution

outline_api-0.0.6-py3-none-any.whl (19.4 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