Skip to main content

Unofficial API client for the FireAPI from 24fire GmbH.

Project description

Python FireAPI Client

Unofficial API client for the FireAPI from 24fire GmbH.

Python

Installation

pip install pyonfireapi 

Examples

1. List all VMs

from pyonfireapi import FireAPIClient

# Set the client and authenticate
client = FireAPIClient("api-key")

# Perform the Request
r = client.vm.list_all_vms()

# Print statuscode
print("Status Code: ", r.status_code)

# Print json
print(r.json())

Output: Status Code: 200

{
    "status": "success",
    "requestID": "a24effc3-b1d6-46a3-a49a-fe07734717ad",
    "message": "All vm data are listed below",
    "data": {
        "total_vms": 2,
        "total_stats": {
            "cores": 12,
            "mem": 3072,
            "disk": 20
        },
        "list": [
            {
                "vmid": 30071,
                "createDate": "2023-05-31T00:38:40.000Z",
                "node": "node09",
                "config": {
                    "cores": 10,
                    "mem": 1024,
                    "disk": 10
                }
            },
            {
                "vmid": 30074,
                "createDate": "2023-06-10T11:10:34.000Z",
                "node": "node09",
                "config": {
                    "cores": 2,
                    "mem": 2048,
                    "disk": 10
                }
            }
        ]
    }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyonfireapi-0.0.4.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

pyonfireapi-0.0.4-py3-none-any.whl (9.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page