Skip to main content

Python API wrapper for Outline VPN

Project description

outline-vpn-api

A Python API wrapper for Outline VPN

Test

How to use

from outline_vpn.outline_vpn import OutlineVPN

# Setup the access with the API URL (Use the one provided to you after the server setup)
client = OutlineVPN(api_url="https://127.0.0.1:51083/xlUG4F5BBft4rSrIvDSWuw")

# Get all access URLs on the server
for key in client.get_keys():
    print(key.access_url)

# Create a new key
new_key = client.create_key()

# Rename it
client.rename_key(new_key.key_id, "new_key")

# Delete it
client.delete_key(new_key.key_id)

# Set a monthly data limit for a key (20MB)
client.add_data_limit(new_key.key_id, 1024 * 1024 * 20)

# Remove the data limit
client.delete_data_limit(new_key.key_id)

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-vpn-api-3.0.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

outline_vpn_api-3.0.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file outline-vpn-api-3.0.0.tar.gz.

File metadata

  • Download URL: outline-vpn-api-3.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for outline-vpn-api-3.0.0.tar.gz
Algorithm Hash digest
SHA256 c4a543c270d0080cdfb6bd81c0034a12c0af098a5dbee2d8c6bb1a2ccbab1905
MD5 26a312a6dd525f39fbb175afd1867e64
BLAKE2b-256 8b652d4647b72f34f61e0e14030fd639e8bfb2c16e8b7b92899e5e18c96f334e

See more details on using hashes here.

File details

Details for the file outline_vpn_api-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for outline_vpn_api-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8782ff1e61b07e78431c97c37336f2699a696c10515144597fdfc2fc40fcf4ec
MD5 cd40b9211acccef8af1eec73e10861a9
BLAKE2b-256 ac71c94f0d7be26dade49256430b4cf35ea483b237c856328376d3bbe96601ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page