SFTPGo Enterprise API: Octri preview

Unofficial Octri preview based on SFTPGo Enterprise REST API v2.7. Scope: list users, retrieve a user, and list virtual folders. Examples use synthetic data. Validation used a local HTTP mock, not a live SFTPGo installation.

Install preview package

Download generated Python SDK, unzip it, then run python -m pip install . inside the extracted directory. Package has not been published to PyPI.

Connect

Create an admin-scoped API key on an authorized SFTPGo Enterprise installation. Enable API key authentication on the relevant admin and HTTPD binding. Supply your own host URL. Do not put keys in source control.

import os
from sftpgo_octri_preview_sdk import ClientAuthConfig, ClientConfig, SFTPGoEnterprise

client = SFTPGoEnterprise(ClientConfig(
  base_url="https://your-sftpgo.example/api/v2",
  auth=ClientAuthConfig(api_key_auth=os.environ["SFTPGO_API_KEY"]),
))
users = client.users.get(offset=0, limit=25)
user = client.users.get_by_username("alice")
folders = client.folders.get(offset=0, limit=25)

These calls map to GET /users, GET /users/{username}, and GET /folders. Generated responses decode as User and BaseVirtualFolder models. The client sends X-SFTPGO-API-KEY. Lists use offset and limit query parameters.

Tested scope and limits

Downloaded Octri SDK v1.0.0 installed locally. Independent mock asserted paths, query values, API-key header, typed response parsing, custom base URL, and typed 401 error. No live API call, write operation, automatic spec sync, or public package registry release was tested. This preview covers Enterprise v2.7 only; do not assume OSS contract equivalence.