Install a module from a direct URL

Downloads a .tar.zst archive from the supplied direct URL, validates the module.json manifest, and registers the module. Newly installed modules start disabled by default. No registry source is stored.

POST /modules

Install a module from a direct URL

cURL

curl --request POST \
  --url http://localhost:9371/modules \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<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 direct URL.

url · string · required

Direct URL of the .tar.zst module archive to download and install.

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