https://github.com/jadolg/outline-vpn-api

A Python API wrapper for Outline VPN https://getoutline.org/
https://github.com/jadolg/outline-vpn-api

api-rest outline shadowsocks vpn

Last synced: about 20 hours ago
JSON representation

A Python API wrapper for Outline VPN https://getoutline.org/

• Host: GitHub
• URL: https://github.com/jadolg/outline-vpn-api
• Owner: jadolg
• License: mit
• Created: 2021-08-09T19:03:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-18T14:32:16.000Z (about 1 month ago)
• Last Synced: 2024-12-15T13:03:01.879Z (8 days ago)
• Topics: api-rest, outline, shadowsocks, vpn
• Language: Python
• Homepage:
• Size: 104 KB
• Stars: 132
• Watchers: 5
• Forks: 30
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# outline-vpn-api

A Python API wrapper for [Outline VPN](https://getoutline.org/)

[![Test](https://github.com/jadolg/outline-vpn-api/actions/workflows/test.yml/badge.svg)](https://github.com/jadolg/outline-vpn-api/actions/workflows/test.yml) ![](https://img.shields.io/pypi/dm/outline-vpn-api.svg) [![codecov](https://codecov.io/github/jadolg/outline-vpn-api/branch/main/graph/badge.svg?token=SLYnaHOxz2)](https://codecov.io/github/jadolg/outline-vpn-api)

## How to use

```python

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",

                    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