Install a module from a registry

Resolves the registry source URL, downloads the .tar.zst archive from the returned downloadUrl, validates the module.json manifest, and registers the module. The registry source URL is stored for future updates via POST /modules/:id/update.

POST /modules/install

Install a module from a registry

cURL

curl --request POST \
  --url http://localhost:9371/modules/install \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "<string>"
}
'

201

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

Body

application/json

Request body used to install a module from a registry.

source · string · required

Registry URL to resolve for module metadata, then download the .tar.zst archive.

Minimum string length: 1

Response

201

application/json

The module manifest record for the newly installed module.

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