Get a module

Returns the module manifest record for the requested module id, including hash, source, and configuration/secrets schemas.

GET /modules/{moduleId}

Get a module

cURL

curl --request GET \
  --url http://localhost:9371/modules/{moduleId}

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isBuiltin": true,
  "enabled": true,
  "missing": true,
  "hash": "<string>",
  "source": "<string>",
  "configSchema": {},
  "secretsSchema": {}
}

Path Parameters

moduleId · string · required

Module identifier.

Minimum string length: 1

Response

200

application/json

Full module manifest record.

Full module manifest record returned by the get module endpoint.

id · string · required

Module identifier.

Minimum string length: 1

name · string · required

Module display name.

Minimum string length: 1

type · enum<string> · required

Module type.

Available options: adapter, environment

description · string · required

Human-readable description of the module.

isBuiltin · boolean · required

Whether the module is bundled with the API.

enabled · boolean · required

Whether the module is currently enabled.

missing · boolean · required

Whether the module is installed but has no matching factory loaded.

hash · string · required

Content hash of the installed module archive.

Minimum string length: 1

source · string · required

Install source URL used to fetch the module archive.

configSchema · object · required

JSON Schema describing the module configuration object.

Show child attributes

secretsSchema · object · required

JSON Schema describing the module secrets object.

Show child attributes