Fetching Jars

GET /api/fetchJar/{type}/{version}

The fetchJar route is a route for fetching a jar from the server based on its type and version. This route will either respond with the error format or with the file to download.

Parameter Type Description
type String The type of jar spigot, bukkit etc
versionoptional String The version of the jar to download 1.14, 1.8 etc

Fetching Latest

GET /api/fetchLatest/{type}

The fetchLatest route is a route for fetching a latest jar from the server based on its type.

Parameter Type Description
type String The type of jar spigot, bukkit etc

Response Format


{
    "status": "success",
    "response": {
        "version": "1.14.4",
        "file_name": "paper-1.14.4.jar",
        "md5_hash": "331f9215946a8d559ffd4fb267c5aa99",
        "built": "November 20, 2019"
    }
}
        

Fetching All

GET /api/fetchAll/{type}

The fetchLatest route is a route for fetching a latest jar from the server based on its type.

Parameter Type Description
type String The type of jar spigot, bukkit etc

Response Format


{
    "status": "success",
    "response": [
        {
            "version": "1.14.3",
            "file_name": "spigot-1.14.3.jar",
            "md5_hash": "331f9215946a8d559ffd4fb267c5aa99",
            "built": "November 20, 2019"
        },
        {
            "version": "1.14.2",
            "file_name": "spigot-1.14.2.jar",
            "md5_hash": "331f9215946a8d559ffd4fb267c5aa99",
            "built": "November 20, 2019"
        }
    ]
}
        

Fetching Types

GET /api/fetchTypes/{type}

The fetchLatest route is a route for fetching a latest jar from the server based on its type.

Parameter Type Description
typeoptional String The type of jars to list servers or proxies

Response Format


{
    "status": "success",
    "response": {
        "proxies": [
            "bungeecord",
            "velocity",
            "waterfall"
        ],
        "servers": [
            "paper",
            "bukkit",
            "spigot"
        ]
    }
}
        

Fetching Docs

GET /api/fetchDocs/{route}

The fetchDocs route is a route for fetching information / documentation on a specific or all routes.

Parameter Type Description
routeoptional String The type of route to list documentation for.

Response Format


{
    "status": "success",
    "docs": [
        {
            "route": "exampleRoute",
            "title": "Example Title",
            "method": "GET",
            "url": "/api/example/{example}",
            "description": "Example description",
            "fields": [
                {
                    "parameter": "example",
                    "type": "String",
                    "description": "Example field",
                    "optional": false
                }
            ],
            "response": {
                "response": "json",
                "json": {
                    "status": "success",
                    "response": []
                }
            }
        }
    ]
}
        

Fetching Routes

GET /api/fetchRoutes

The fetchRoutes route is a route for fetching all the different api routes.

Response Format


{
    "status": "success",
    "response": [
        "fetchJar",
        "fetchLatest...",
        "etc..."
    ]
}
        

Error Response Format


{
    "status": "error",
    "error": {
        "title": "Example Title",
        "message": "Example error message"
    }
}