Bareos REST API using fastAPI and python-bareos
Experimental and subject to enhancements and changes.
This is an experimental backend for development purposes.
It provides a REST API using fastapi and python-bareos to connect to a Bareos director.
Guide
Installation
We recommend to create a dedicated Python environment for the installation in an own directory:
python3 -m venv env
# Activate the virtual environment inside the directory
source env/bin/activate
# Install dependencies into the virtual environment
pip install bareos-restapi
Note: The optional module sslpsk can be installed manually, if you want encrypted communication between the API and the Bareos director.
Configuration
The module directory contains a sample ini-file. Change into this directory (something like /lib/python3.x/site-packages/bareosRestapiModels on most operating systems) and copy api.ini.sample to api.ini and adapt it to your director. Make sure to generate an own secret-key for the JWT section.
Your director configuration in api.ini should look like:
[Director]
Name=bareos-dir
Address=127.0.0.1
Port=9101
Note: you will need a named console (user/password) to acces the Bareos director using this API. Read more about Consoles here: https://docs.bareos.org/Configuration/Director.html#console-resource
Start the backend server
From inside the module directory run:
uvicorn bareos_restapi:app --reload
- Serve the Swagger UI to explore the REST API: http://127.0.0.1:8000/docs
- Alternatively you can use the redoc format: http://127.0.0.1:8000/redoc
Browse
The Swagger UI contains documentation and online-tests. Use "authorize" to connect to your Bareos director using a named console. Read here to learn how to configure a named console: https://docs.bareos.org/Configuration/Director.html#console-resource
The Swagger documentation also contains CURL statements for all available endpoints.
Future work
The API will be extended by some methods provided by the Bareos console, that are not yet implemented. It is also planned to add delete / update options for configuration in the director and REST API. If you are interested in support and / or funding enhancements, please visit https://www.bareos.com
TODO:
- define and document response model
- add possibility to connect to a choice of directors
- add start-script with ini-file name as parameter
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bareos_restapi-25.1.0.tar.gz.
File metadata
- Download URL: bareos_restapi-25.1.0.tar.gz
- Upload date:
- Size: 42.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fdea31c0152191f78d5ce5d50e00da09ed3661f88829f2978ffe42e9262be61b
|
|
| MD5 |
c7716513ed11ac31f79965e39d90faee
|
|
| BLAKE2b-256 |
381ddf85f3c6172dd4ff908f6ad86c979e36a85ccd1cfc3001581d1e7051b537
|
Provenance
The following attestation bundles were made for bareos_restapi-25.1.0.tar.gz:
Publisher:
publish-python-packages-to-pypi.yml on bareos/bareos
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bareos_restapi-25.1.0.tar.gz -
Subject digest:
fdea31c0152191f78d5ce5d50e00da09ed3661f88829f2978ffe42e9262be61b - Sigstore transparency entry: 2334169233
- Sigstore integration time:
-
Permalink:
bareos/bareos@f2b00c1cdc18f542b5f269c292926f1eabd97320 -
Branch / Tag:
refs/tags/Release/25.1.0 - Owner: https://github.com/bareos
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python-packages-to-pypi.yml@f2b00c1cdc18f542b5f269c292926f1eabd97320 -
Trigger Event:
push
-
Statement type:
File details
Details for the file bareos_restapi-25.1.0-py3-none-any.whl.
File metadata
- Download URL: bareos_restapi-25.1.0-py3-none-any.whl
- Upload date:
- Size: 41.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0350be2e88a141fb9c6c096b27fd477161cd7c61a3e51118dcc4b7c6c6838c55
|
|
| MD5 |
ac6daa857ccd10de3be44073217d21f6
|
|
| BLAKE2b-256 |
2175a1db8ed4919b87fc433fbe9be645a3d2b95f659d31b8fa1e60ff5d0235d5
|
Provenance
The following attestation bundles were made for bareos_restapi-25.1.0-py3-none-any.whl:
Publisher:
publish-python-packages-to-pypi.yml on bareos/bareos
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
bareos_restapi-25.1.0-py3-none-any.whl -
Subject digest:
0350be2e88a141fb9c6c096b27fd477161cd7c61a3e51118dcc4b7c6c6838c55 - Sigstore transparency entry: 2334169245
- Sigstore integration time:
-
Permalink:
bareos/bareos@f2b00c1cdc18f542b5f269c292926f1eabd97320 -
Branch / Tag:
refs/tags/Release/25.1.0 - Owner: https://github.com/bareos
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python-packages-to-pypi.yml@f2b00c1cdc18f542b5f269c292926f1eabd97320 -
Trigger Event:
push
-
Statement type:
