Get a catalog plugin with its versions

GET

/catalog/plugin

curl --request GET \
  --url 'https://example.com/api/v1/catalog/plugin?id=example' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Any signed-in user. A plugin by its catalog ID (modrinth:<project> or hangar:<owner>/<slug>, passed as the id query parameter since it may contain a slash), with its versions, newest first, and any denylist entries.

Authorizations

• sessionCookie
• bearerToken

Parameters

Query Parameters

id

required

string

>= 3 characters <= 200 characters

Responses

200

The plugin.

Media typeapplication/json

object

id

required

string

source

required

string

Allowed values: modrinth hangar

slug

required

string

name

required

string

summary

required

string

license

required

string

downloads

required

integer format: int64

url

required

The project page at its source.

string

updated

required

string format: date-time

versions

required

Array<object>

object

id

required

string

version

required

string

channel

required

string

Allowed values: release beta alpha

platforms

required

Array<string>

gameVersions

required

Array<string>

published

required

string format: date-time

fileName

required

string

sizeBytes

required

integer format: int64

dependencies

required

Array<object>

object

pluginId

Set when the dependency is in the catalog.

string

name

required

string

required

required

boolean

denials

required

Denylist entries about this plugin; denied versions are not listed.

Array<object>

object

versions

required

Empty means every version.

Array<string>

reason

required

string

link

string

Example

{
  "id": "modrinth:Vebnzrzj",
  "source": "modrinth",
  "versions": [
    {
      "channel": "release"
    }
  ]
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

404

Not found, or not visible to you.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}