ampapi

ampapi-py

Note: This library is 95% generated code with no soul whatsoever. If you're more interested in a nicer developer experience, check out k8thekat's AMPAPI_Python

An API that allows you to communicate with AMP installations from within Python.

Documentation for available API calls can be found by appending /API to the URL of any existing AMP installation.

Support:

• Ping @thepotatoking3452 in the #development channel of the AMP Discord
• My own development Discord

Installation

pip install ampapi

You also need the following packages installed:

pip install requests aiohttp json dataclass_wizard

Examples

CommonAPI Example

from ampapi.auth import BasicAuthProvider
from ampapi.modules import CommonAPI
from ampapi.types import MetricInfo, StatusResponse

def main():
    # You can also use a RefreshingAuthProvider for long-lived scripts
    authProvider = BasicAuthProvider(
        panelUrl="http://localhost:8080/",
        username="admin",
        password="myfancypassword123"
    )

    # If you know the module that the instance is using, specify it instead of CommonAPI
    API = CommonAPI(authProvider)

    # API call parameters are simply in the same order as shown in the documentation.
    API.Core.SendConsoleMessage("say Hello Everyone, this message was sent from the Python API!")

    currentStatus: StatusResponse = API.Core.GetStatus()
    cpuUsage: MetricInfo = currentStatus.Metrics.get("CPU Usage")

    print(f"Current CPU usage is: {cpuUsage.Percent}%")

main()

Async CommonAPI Example

import asyncio
from ampapi.auth import BasicAuthProviderAsync
from ampapi.modules import CommonAPIAsync
from ampapi.types import MetricInfo, StatusResponse

async def main():
    # You can also use a RefreshingAuthProvider for long-lived scripts
    authProvider = BasicAuthProviderAsync(
        panelUrl="http://localhost:8080/",
        username="admin",
        password="myfancypassword123"
    )

    # If you know the module that the instance is using, specify it instead of CommonAPI
    API = CommonAPIAsync(authProvider)

    # API call parameters are simply in the same order as shown in the documentation.
    await API.Core.SendConsoleMessage("say Hello Everyone, this message was sent from the Python API!")

    currentStatus: StatusResponse = await API.Core.GetStatus()
    cpuUsage: MetricInfo = currentStatus.Metrics.get("CPU Usage")

    print(f"Current CPU usage is: {cpuUsage.Percent}%")

asyncio.run(main())

THE BELOW EXAMPLES ARE OUTDATED

Example using the ADS to manage an instance

from ampapi.modules.ADS import ADS

API = ADS("http://localhost:8080/", "admin", "myfancypassword123")
API.Login()

# Get the available instances
targets = API.ADSModule.GetInstances()

# In this example, my Hub server is on the second target
# If you're running a standalone setup, you can just use targets[1]
target = targets[1]

hub_instance_id = ""

# Get the available instances
instances = target.AvailableInstances
for instance in instances:
    # Find the instance named "Hub"
    if instance.InstanceName == "Hub":
        hub_instance_id = instance.InstanceID
        break

# Use the instance ID to get the API for the instance
Hub = API.InstanceLogin(hub_instance_id, "Minecraft")

# Get the current CPU usage
currentStatus = Hub.Core.GetStatus()
CPUUsagePercent = currentStatus.Metrics["CPU Usage"].Percent

# Send a message to the console
Hub.Core.SendConsoleMessage(f"say Current CPU usage is {CPUUsagePercent}%")

CommonAPI Example, handling the sessionId and rememberMeToken manually (not recommended)

from ampapi.modules.CommonAPI import CommonAPI

try:
    API = CommonAPI("http://localhost:8080/")

    # The third parameter is either used for 2FA logins, or if no password is specified to use a remembered token from a previous login, or a service login token.
    loginResult = API.Core.Login("admin", "myfancypassword123", "", False)

    if loginResult.success:
        print("Login successful")
        API.sessionId = loginResult.sessionID
        API.Core.sessionId = loginResult.sessionID

        # API call parameters are simply in the same order as shown in the documentation.
        API.Core.SendConsoleMessage("say Hello Everyone, this message was sent from the Python API!")
        currentStatus = API.Core.GetStatus()
        CPUUsagePercent = currentStatus.Metrics["CPU Usage"].Percent
        print(f"Current CPU usage is: {CPUUsagePercent}%")

    else:
        print("Login failed")
        print(loginResult)

except Exception as err:
    # In reality, you'd handle this exception better
    raise Exception(err)