veeam-br 0.1.1b2

Veeam Backup & Replication REST API wrapper for Python

Veeam Backup & Replication Python API Wrapper

Python package for interacting with the Veeam Backup & Replication REST API

This project is an independent, open source Python client for the Veeam Backup & Replication REST API. It is not affiliated with, endorsed by, or sponsored by Veeam Software.

Supported Versions

VBR Version	API Version	Supported
13.0.1.180	1.3-rev1	✅
13.0.0.4967	1.3-rev0	✅
12.3.1.1139	1.2-rev1	✅
< 12.3.1.1139	< 1.2-rev1	❌

How to support new API versions

1. Download the OpenAPI schema into openapi_schemas
2. Install the openapi-python-client package
3. Run python fix_openapi_yaml.py .\openapi_schemas\vbr_rest_{version}.yaml .\openapi_schemas\vbr_rest_{version}_fixed.yaml
4. Run openapi-python-client generate --path ".\openapi_schemas\vbr_rest_{version}_fixed.json" --output-path ".\veeam_br" --overwrite
5. Fix any warnings/errors
6. Rename the folder to match the API version (i.e., v1.3-rev1)
7. Write pytest tests
8. If an older API has been deprecated, delete its folder and yaml, then update the supported versions section of the readme

Install

From PyPi

pip install veeam-br

From Source

Clone the repository and install dependencies:

git clone https://github.com/Cenvora/veeam-br.git
cd veeam-br
pip install -e .

Usage

Basic Usage

First, create a client from the appropriate API version:

from veeam_br.v1_3_rev1 import Client

client = Client(base_url="https://api.example.com:9419")

Log in to the service (this requires an account with MFA disabled):

from veeam_br.v1_3_rev1.client import Client
from veeam_br.v1_3_rev1.models.token_login_spec import TokenLoginSpec
from veeam_br.v1_3_rev1.api.login import create_token
from veeam_br.v1_3_rev1.models.e_login_grant_type import ELoginGrantType

client = Client(
    base_url="https://vbr.example.com:9419",
    verify_ssl=False
)

body = TokenLoginSpec(
    grant_type=ELoginGrantType.PASSWORD,
    username="administrator",
    password="SuperSecretPassword"
)

with client as client:
    token = create_token.sync(
        client=client,
        body=body,
        x_api_version="1.3-rev1",
    )

Now switch to the AuthenticatedClient:

auth_client = AuthenticatedClient(
    base_url=client._base_url,
    token=token.access_token,
    verify_ssl=client._verify_ssl,
)

Now call your endpoint and use your models:

from veeam_br.v1_3_rev1.models import ServerTimeModel
from veeam_br.v1_3_rev1.api.service import get_server_time
from veeam_br.v1_3_rev1.types import Response

with auth_client as auth_client:
    my_data: ServerTimeModel = get_server_time.sync(client=auth_client, x_api_version="1.3-rev1")
    # or if you need more info (e.g. status_code)
    response: Response[ServerTimeModel] = get_server_time.sync_detailed(client=auth_client, x_api_version="1.3-rev1")

Async Usage

Or do the same thing with an async version:

from veeam_br.v1_3_rev1.models import ServerTimeModel
from veeam_br.v1_3_rev1.api.service import get_server_time
from veeam_br.v1_3_rev1.types import Response

async with auth_client as auth_client:
    my_data: ServerTimeModel = await get_server_time.asyncio(client=auth_client, x_api_version="1.3-rev1")
    response: Response[ServerTimeModel] = await get_server_time.asyncio_detailed(client=auth_client, x_api_version="1.3-rev1")

SSL Verification

By default, HTTPS APIs will verify SSL certificates. You can pass a custom certificate bundle or disable verification (not recommended):

client = AuthenticatedClient(
    base_url="https://internal_api.example.com:9419", 
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

# Disable SSL verification (security risk)
client = AuthenticatedClient(
    base_url="https://internal_api.example.com:9419", 
    token="SuperSecretToken", 
    verify_ssl=False
)

Contributing

Contributions are welcome! To contribute:

• Fork the repository
• Create a feature branch
• Make your changes and add tests
• Submit a pull request with a clear description

Please follow PEP8 style and include docstrings for new functions/classes.

🤝 Core Contributors

This project is made possible thanks to the efforts of our core contributors:

• Jonah May
• Maurice Kevenaar

We’re grateful for their continued support and contributions.