Skip to content
Modrinth Documentation

Forge Updates JSON file

GET
/updates/{id|slug}/forge_updates.json

If you’re a Forge mod developer, your Modrinth mods have an automatically generated updates.json using the Forge Update Checker.

The only setup is to insert the URL into the [[mods]] section of your mods.toml file as such:

[[mods]]
# the other stuff here - ID, version, display name, etc.
updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json"

Replace {slug|id} with the slug or ID of your project.

Modrinth will handle the rest! When you update your mod, Forge will notify your users that their copy of your mod is out of date.

Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your mods.toml. If you use a format such as 1.2.3-forge or 1.2.3+1.19 with your Modrinth releases but your mods.toml only has 1.2.3, the update checker may not function properly.

Parameters

Path Parameters

id|slug
required
string
[
  "AABBCCDD",
  "my_project"
]

The ID or slug of the project

Responses

200

Expected response to a valid request

Mod version information that can be consumed by Forge’s update checker

object
homepage

A link to the mod page

string
https://modrinth.com
promos

A list of the recommended and latest versions for each Minecraft release

object
{version}-recommended

The mod version that is recommended for {version}. Excludes versions with the alpha and beta version types.

string
{version}-latest

The latest mod version for {version}. Shows versions with the alpha and beta version types.

string

400

Invalid request

object
error
required

The name of the error

string
invalid_input
description
required

The contents of the error

string
Error while parsing multipart payload