fireapi 0.4.3

A simple API wrapper for the 24Fire REST API

FireAPI

Overview

FireAPI is a Python library that serves as a wrapper for the 24Fire REST API. It allows you to perform basic operations on a KVM server using a private API key. The library provides the following functionalities:

• Get server configuration
• Get server status
• Start server
• Stop server
• Restart server
• Delete backup (exclusive to 24fire+ subscribers)
• Create backup (exclusive to 24fire+ subscribers)
• List all backups (exclusive to 24fire+ subscribers)
• Retrieve monitoring timings (exclusive to 24fire+ subscribers)
• Retrieve monitoring incidences (exclusive to 24fire+ subscribers)
• Async Support

[!NOTE] Disclaimer: Unable to test 24fire+ exclusive features due to lack of subscription. If you encounter issues, please report them on GitHub.

Table of Contents

• Installation
• Usage
  • Synchronous Usage
  • Asynchronous Usage
• Documentation
• Contributing
• License

Installation

To install FireAPI, use pip:

pip install fireapi

Alternatively, you can build and install the package manually:

git clone https://github.com/EvickaStudio/24-Fire-REST-API.git
cd 24-Fire-REST-API
python -m build
pip install ./

Usage

Synchronous Usage

To get started, import the FireAPI class from the fireapi package and instantiate it using your API key:

from fireapi import FireAPI

API_KEY = "your-api-key-here"
fire_api = FireAPI(API_KEY)

Once the instance is created, you can interact with the 24Fire REST API using the provided methods:

# Get server configuration
config = fire_api.get_config()
print(config)

# Get server status
status = fire_api.get_status()
print(status)

# Start server
start = fire_api.start_server()
print(start)

# Stop server
stop = fire_api.stop_server()
print(stop)

# Restart server
restart = fire_api.restart_server()
print(restart)

# Delete a backup
delete_backup = fire_api.backup_delete("backup_id")

# Create a backup
create_backup = fire_api.backup_create("Backup description")

# List all backups
backups = fire_api.backup_list()

# Retrieve monitoring timings
timings = fire_api.timings()

# Retrieve monitoring incidences
incidences = fire_api.incidences()

Asynchronous Usage

When using the async methods, you can use the await keyword to wait for the response:

import asyncio
from fireapi import AsyncFireAPI

async def main():
    API_KEY = "your-api-key-here"
    try:
        fire_api = AsyncFireAPI(API_KEY)
        # Get server configuration
        config = await fire_api.get_config()
        print(config)
        # And the other methods that FireAPI provides
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    asyncio.run(main())

Documentation

For more information on the 24Fire REST API, refer to the original documentation.

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

License

This project is licensed under the AGPL v3 License.