List a server's plugins

GET

/servers/{serverId}/plugins

curl --request GET \
  --url 'https://example.com/api/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plugins?unmanaged=false' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Needs plugins.read. The plugins Shardkeep manages on the server, with any denylist entry and the newest compatible catalog version when it is newer. With unmanaged=true, the server’s Agent is also asked for the jars users placed in plugins/ themselves; a jar declaring the same plugin name as a managed plugin is flagged, since the server would load only one of them.

Authorizations

• sessionCookie
• bearerToken

Parameters

Path Parameters

serverId

required

string format: uuid

Query Parameters

unmanaged

boolean

Responses

200

The plugins.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

The installation’s ID.

string format: uuid

pluginId

required

The catalog plugin ID, or upload:<name> for an uploaded jar.

string

name

required

string

source

required

string

Allowed values: CATALOG UPLOAD

version

required

string

catalogVersionId

string

verified

required

False for uploads.

boolean

compatibilityConfirmed

required

False when it was installed with force, or is an upload.

boolean

dependency

required

True when it was installed because another plugin requires it.

boolean

requiredBy

required

Plugin IDs of installed plugins that require this one.

Array<string>

denied

Set when the catalog’s denylist names this version.

object

reason

required

string

link

string

updateAvailable

The newest catalog version compatible with the server, when it is newer than this one.

object

versionId

required

string

version

required

string

installedAt

required

string format: date-time

updatedAt

required

string format: date-time

pendingRestart

required

True while the running server has plugin or software changes waiting for its next start.

boolean

unmanaged

object

available

required

False when the server’s Agent could not be asked (its Node is not connected, or it has no container yet).

boolean

items

required

Array<object>

object

fileName

required

string

sizeBytes

required

integer format: int64

pluginName

From the jar’s plugin.yml; absent when it has none.

string

pluginVersion

string

duplicateOf

A managed plugin installation declaring the same plugin name.

string format: uuid

truncated

required

boolean

Example

{
  "items": [
    {
      "pluginId": "modrinth:Vebnzrzj",
      "source": "CATALOG"
    }
  ]
}

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

403

Signed in, but not allowed.

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