{"id":15023120,"url":"https://github.com/jadolg/outline-vpn-api","last_synced_at":"2026-05-11T19:05:11.267Z","repository":{"id":37088352,"uuid":"394408218","full_name":"jadolg/outline-vpn-api","owner":"jadolg","description":"A Python API wrapper for Outline VPN https://getoutline.org/","archived":false,"fork":false,"pushed_at":"2026-04-13T06:46:51.000Z","size":247,"stargazers_count":146,"open_issues_count":4,"forks_count":34,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-13T08:27:57.142Z","etag":null,"topics":["api-rest","hacktoberfest","outline","shadowsocks","vpn"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jadolg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"jadolg"}},"created_at":"2021-08-09T19:03:51.000Z","updated_at":"2026-04-13T06:46:54.000Z","dependencies_parsed_at":"2023-02-15T12:31:06.228Z","dependency_job_id":"fedc7777-8b02-4f2a-a6dc-e5b1b1db76c5","html_url":"https://github.com/jadolg/outline-vpn-api","commit_stats":{"total_commits":127,"total_committers":7,"mean_commits":"18.142857142857142","dds":"0.17322834645669294","last_synced_commit":"b50363f843d56d8f43e69e31187038e305dd6425"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/jadolg/outline-vpn-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Foutline-vpn-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Foutline-vpn-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Foutline-vpn-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Foutline-vpn-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jadolg","download_url":"https://codeload.github.com/jadolg/outline-vpn-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadolg%2Foutline-vpn-api/sbom","scorecard":{"id":501775,"data":{"date":"2025-08-11","repo":{"name":"github.com/jadolg/outline-vpn-api","commit":"d1934ff9bfee176eecb00cc1144803a5d45e8d5e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 2/12 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/jadolg/outline-vpn-api/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/jadolg/outline-vpn-api/publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/jadolg/outline-vpn-api/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/jadolg/outline-vpn-api/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/jadolg/outline-vpn-api/test.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/publish.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/publish.yml:20","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:29","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:31","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   5 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":4,"reason":"SAST tool is not run on all commits -- score normalized to 4","details":["Warn: 10 commits out of 25 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T22:06:19.704Z","repository_id":37088352,"created_at":"2025-08-19T22:06:19.704Z","updated_at":"2025-08-19T22:06:19.704Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32908553,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-11T17:09:15.040Z","status":"ssl_error","status_checked_at":"2026-05-11T17:08:45.420Z","response_time":120,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","hacktoberfest","outline","shadowsocks","vpn"],"created_at":"2024-09-24T19:58:45.071Z","updated_at":"2026-05-11T19:05:11.259Z","avatar_url":"https://github.com/jadolg.png","language":"Python","funding_links":["https://github.com/sponsors/jadolg"],"categories":[],"sub_categories":[],"readme":"# outline-vpn-api\n\nA Python API wrapper for [Outline VPN](https://getoutline.org/)\n\n[![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)\n\n## How to use\n\n```python\nfrom outline_vpn import OutlineVPN\n\n# Setup the access with the API URL (Use the one provided to you after the server setup)\nclient = OutlineVPN(api_url=\"https://127.0.0.1:51083/xlUG4F5BBft4rSrIvDSWuw\",\n                    cert_sha256=\"4EFF7BB90BCE5D4A172D338DC91B5B9975E197E39E3FA4FC42353763C4E58765\")\n\n# Get all access URLs on the server\nfor key in client.get_keys():\n    print(key.access_url)\n\n# Create a new key\nnew_key = client.create_key()\n\n# Or create a key with a specific attributes\nkey = client.create_key(\n    key_id=\"new_key_001\",\n    name=\"Yet another test key\",\n    data_limit=1024 * 1024 * 20,\n    method=\"aes-192-gcm\",\n    password=\"test\",\n    port=2323,\n)\n\n# Rename it\nclient.rename_key(new_key.key_id, \"new_key\")\n\n# Delete it\nclient.delete_key(new_key.key_id)\n\n# Set a monthly data limit for a key (20MB)\nclient.add_data_limit(new_key.key_id, 1000 * 1000 * 20)\n\n# Remove the data limit\nclient.delete_data_limit(new_key.key_id)\n\n```\n\n## API documentation\n\n\u003chttps://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/Jigsaw-Code/outline-server/master/src/shadowbox/server/api.yml\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadolg%2Foutline-vpn-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjadolg%2Foutline-vpn-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadolg%2Foutline-vpn-api/lists"}