API Documentation

A documentation for developer

Health

GET Latest health data

HTTP Request

GET https://manage.runcloud.io/base-api/servers/<server.id>/health

Request

curl -X GET "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/health" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "lastCheckedIn": "3 minutes ago",
    "latestData": {
        "load": "0.00",
        "memoryChart": {
            "labels": [
                "Used",
                "Available"
            ],
            "dataset": {
                "unit": "MB",
                "data": [
                    681.63,
                    310.47
                ],
                "backgroundColor": [
                    "#F39C12",
                    "#2C3E50"
                ]
            }
        },
        "diskChart": {
            "labels": [
                "Used",
                "Available"
            ],
            "dataset": {
                "unit": "MB",
                "data": [
                    4127.79,
                    3135.16
                ],
                "backgroundColor": [
                    "#F39C12",
                    "#2C3E50"
                ]
            }
        }
    }
}

PATCH Clean disk

HTTP Request

PATCH https://manage.runcloud.io/base-api/servers/<server.id>/health/cleandisk

Request

curl -X PATCH "https://manage.runcloud.io/base-api/servers/yO4VAbX2BkNz/health/cleandisk" \
    -u YOUR_API_KEY:YOUR_API_SECRET \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"

Response

{
    "message": "Server ARunCloudDev hard disk will be cleaned up in a few moments."
}