outline-vpn-api
A Python API wrapper for Outline VPN
How to use
from 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",
cert_sha256="4EFF7BB90BCE5D4A172D338DC91B5B9975E197E39E3FA4FC42353763C4E58765")
# 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()
# Or create a key with a specific attributes
key = client.create_key(
key_id="new_key_001",
name="Yet another test key",
data_limit=1024 * 1024 * 20,
method="aes-192-gcm",
password="test",
port=2323,
)
# 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, 1000 * 1000 * 20)
# Remove the data limit
client.delete_data_limit(new_key.key_id)
API documentation
1 maintainer
Metadata
1 maintainer
Release files for outline-vpn-api 6.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| outline_vpn_api-6.6.1.tar.gz | 30.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| outline_vpn_api-6.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 36.0 kB
Release files / outline_vpn_api-6.6.1.tar.gz
| Download URL | outline_vpn_api-6.6.1.tar.gz |
|---|---|
| Size | 30.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ec61dda6c0f476a93b03860a30ceeceb723b9e395a00bc7d0e920746c0fd3ab
|
|
BLAKE2b-256 checksum How to use checksums |
88ef28a34d6cd3f28fe189d0e9607d8755d44fefedf3e858149af4308ae27441
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 11, 2026.
Transparency logRelease files / outline_vpn_api-6.6.1-py3-none-any.whl
| Download URL | outline_vpn_api-6.6.1-py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
40d9fb9adc3967fc7ab7e4c5d653836d69c935568bbeff5735cd631731b851ed
|
|
BLAKE2b-256 checksum How to use checksums |
42f34ffb053d03c20476c183a274b18c89a2a80de1803294d9a99c5fe2810921
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 11, 2026.
Transparency log
