Skip to main content

Python client for the Outline VPN Management API. Manage access keys, server settings, and metrics programmatically.

Project description

OUTLINE-VPN-API-CLIENT

PyPI - Version PyPI - Format GitHub Release GitHub Actions Workflow Status PyPI - Python Version GitHub License Documentation Status

DESCRIPTION

Python client for the Outline VPN Management API. Manage access keys, configure server settings, and retrieve metrics — both synchronously and asynchronously.

INSTALLATION

pip install outline-vpn-api-client

For async support:

pip install outline-vpn-api-client[async]

QUICK START

from outline_vpn_api_client import OutlineClient

client = OutlineClient(management_url="your.management.url")

# Get server info
print(client.get_information().model_dump())

# Create an access key
key = client.access_keys.create(name="Alice", limit=10**9)
print(key.accessUrl)

For full usage examples and API reference, see the documentation.

HANDLING ERRORS

from outline_vpn_api_client import OutlineClient, ResponseNotOkException

try:
    client.access_keys.get(999)
except ResponseNotOkException as e:
    print(e)

AUTHOR

Created by zeph1rr
Email: grianton535@gmail.com

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_client-1.3.1.tar.gz (11.3 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_client-1.3.1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file outline_vpn_api_client-1.3.1.tar.gz.

File metadata

  • Download URL: outline_vpn_api_client-1.3.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.12 Linux/6.14.0-1017-azure

File hashes

Hashes for outline_vpn_api_client-1.3.1.tar.gz
Algorithm Hash digest
SHA256 916d4fe34215570d42a722b69ef46c0afe51e40b4d5025b9757d7c5c39657fc8
MD5 ebb2843cb7b761772b3469257717467a
BLAKE2b-256 5700ea7ea1c52e629e5ca27f3daed65f8632e4ea4ee33dd49915705df793c56a

See more details on using hashes here.

File details

Details for the file outline_vpn_api_client-1.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for outline_vpn_api_client-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 284af2e3e4f71b4cc0f7d68acfd44f0a148f729594fd5fd4f50469dc7707bf59
MD5 6d6a82b9ec367a8a95de0a67e0e21bc5
BLAKE2b-256 bb0854c804de5eb06cb72b112ff32319e02cec2ac7ee2403c2414a648db99bf5

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