---
sidebar_position: 5
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Minecraft Mod Update Checker
A simple way for a mod to check if it is up to date

## GET /v1/updates/minecraft/mods/
→ /v1/updates/minecraft/mods/*<span style={{ color: "green" }}>package</span>*/*<span style={{ color: "green" }}>modloader</span>*/*<span style={{ color: "green" }}>minecraftversion</span>*/*<span style={{ color: "green" }}>modversion</span>*

| Parameter        | Type                | Description                                         | Example                     | Required | Default Value (if optional) |
| ---------------- | ------------------- | --------------------------------------------------- | -------------------------   | -------- | --------------------------- |
| package name     | String              | Full package name (letter case **RELEVANT**)        | "me.jonasjones.mcwebserver" | Yes      | -                           |
| modloader        | String              | modloader id ("fabricquilt" or "forge")             | "fabricquilt                | Yes      | -                           |
| minecraftversion | Version Number      | The Minecraft Version                               | "1.14.4"                    | Yes      | -                           |
| modversion       | Version Number      | The Mod Version                                     | "0.3.2"                     | Yes      | -                           |

:::tip[**Example** Response]
<Tabs>
    <TabItem value="200" label="200">
```json
{
    "promos": {
        "latest": "0.3.2",
        "recommended": "0.3.2"
    },
    "upToDate": true,
    "telemetry_enabled": false
}
```
| Parameter         | Type           | Description                                                                   |
| ----------------- | -------------- | ----------------------------------------------------------------------------- |
| latest            | Version Number | The version number of the latest version for the given Minecraft Version      |
| recommended       | Version Number | The version number of the recommended version for the given Minecraft Version |
| upToDate          | Boolean        | Wether the mod is up to date or not                                           |
| telemetry_enabled | Boolean        | Wether telemetry is enabled or not                                            |
    </TabItem>
    <TabItem value="400" label="400">
```json
{
    "status": 400,
    "statusText": "Bad Request"
}
```
| Parameter  | Type   | Description                  |
| ---------- | ------ | ---------------------------- |
| status     | Number | The status code of the error |
| statusText | String | The status text of the error |
    </TabItem>
    <TabItem value="500" label="500">
```json
{
    "status": 500,
    "statusText": "Internal Server Error"
}
```
| Parameter  | Type   | Description                  |
| ---------- | ------ | ---------------------------- |
| status     | Number | The status code of the error |
| statusText | String | The status text of the error |
    </TabItem>
    <TabItem value="503" label="503">
```json
API is down
{
    "status": 503,
    "statusText": "Service Unavailable"
}
```
| Parameter  | Type   | Description                  |
| ---------- | ------ | ---------------------------- |
| status     | Number | The status code of the error |
| statusText | String | The status text of the error |
    </TabItem>
</Tabs>
:::
