Search the plugin catalog

GET

/catalog/plugins

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

Any signed-in user. Plugins in the synced catalog, most downloaded first, optionally matching search (name, slug or summary) and having a version for platform and gameVersion. Installing plugins comes with Phase 9.

Authorizations

• sessionCookie
• bearerToken

Parameters

Query Parameters

search

string

<= 100 characters

platform

string

Allowed values: paper purpur spigot bukkit folia

gameVersion

string

<= 32 characters

cursor

string

<= 200 characters

The nextCursor of the previous page.

limit

integer

>= 1 <= 200

At most this many items (default 50).

Responses

200

Matching plugins.

Media typeapplication/json

object

items

required

Array<object>

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

nextCursor

string

Example

{
  "items": [
    {
      "id": "modrinth:Vebnzrzj",
      "source": "modrinth"
    }
  ]
}

400

The request is 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"
}

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"
}