Read one API-version-qualified plugin

GET

/plugins/{apiVersion}/{id}

curl --request GET \
  --url https://example.com/api/v1/plugins/example/example

• API v1

Looks up one durable plugin by exact API-version namespace and case-insensitive plugin id. Valid persisted identity values are not trimmed, and no API version is inferred.

Parameters

Path Parameters

apiVersion

required

string

>= 1 characters

Exact non-empty plugin contract API-version namespace; no current version is inferred.

id

required

string

>= 1 characters

Non-empty persisted plugin id; lookup is case-insensitive within the selected namespace.

Responses

200

Redacted durable plugin state

Media typeapplication/json

object

pluginsEnabled

required

boolean

plugin

required

Durable, redacted plugin discovery and enablement state.

object

manifest

required

Validated manifest metadata. Authored identifiers and names are returned exactly as persisted; local source directories and unvalidated raw manifest content are never exposed.

object

apiVersion

required

string

>= 1 characters <= 32 characters

id

required

string

>= 1 characters <= 253 characters

name

required

string

>= 1 characters <= 256 characters

version

required

string

>= 1 characters <= 128 characters

runtime

required

string

Allowed values: wasm

entry

required

Manifest-relative module entry; never an absolute source path.

string

>= 1 characters <= 1024 characters

extensionPoints

required

Array<string>

>= 1 items <= 9 items

Allowed values: config.profileCompiled.observe sync.previewComputed.observe config.validation.observe sync.beforeApply.observe sync.afterApply.observe parser.releaseTitle.transform customFormat.condition.evaluate notification.dispatch.observe importExport.adapter

capabilities

required

Array<string>

<= 4 items

Allowed values: read:resolved-profile read:sync-preview read:custom-format read:config-validation

description

string

<= 2048 characters

author

string

<= 256 characters

engines

Advisory host-version constraints from the validated manifest.

object

praxrr

string

>= 1 characters <= 256 characters

enabled

required

Persisted administrator intent; does not assert runtime activation or execution.

boolean

discovered

required

Whether the plugin was present in the latest successfully reconciled scan.

boolean

state

required

Last recorded lifecycle state. enabled is administrator intent and does not imply that a plugin was activated or executed successfully.

string

Allowed values: discovered validated registered rejected activated failed unloaded

registeredAt

required

string format: date-time

lastError

required

One of:

string

string

null

null

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "pluginsEnabled": true,
  "plugin": {
    "manifest": {
      "runtime": "wasm",
      "extensionPoints": [
        "config.profileCompiled.observe"
      ],
      "capabilities": [
        "read:resolved-profile"
      ]
    },
    "state": "discovered"
  }
}

400

Empty or otherwise invalid path identity

Media typeapplication/json

object

code

required

Stable management failure code; raw filesystem/database diagnostics are never returned.

string

Allowed values: invalid_identity plugins_disabled plugin_not_found internal_error

error

required

string

Example

{
  "code": "invalid_identity"
}

404

Plugin not found in the requested API-version namespace

Media typeapplication/json

object

code

required

Stable management failure code; raw filesystem/database diagnostics are never returned.

string

Allowed values: invalid_identity plugins_disabled plugin_not_found internal_error

error

required

string

Example

{
  "code": "invalid_identity"
}

409

Plugin management is disabled (ecosystem enablement off)

Media typeapplication/json

object

code

required

Stable management failure code; raw filesystem/database diagnostics are never returned.

string

Allowed values: invalid_identity plugins_disabled plugin_not_found internal_error

error

required

string

Example

{
  "code": "invalid_identity"
}

500

Failed to read durable plugin state

Media typeapplication/json

object

code

required

Stable management failure code; raw filesystem/database diagnostics are never returned.

string

Allowed values: invalid_identity plugins_disabled plugin_not_found internal_error

error

required

string

Example

{
  "code": "invalid_identity"
}