Get a module
curl --request GET \
--url http://localhost:9371/modules/{moduleId}import requests
url = "http://localhost:9371/modules/{moduleId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:9371/modules/{moduleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "9371",
CURLOPT_URL => "http://localhost:9371/modules/{moduleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:9371/modules/{moduleId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:9371/modules/{moduleId}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9371/modules/{moduleId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "adapter",
"description": "<string>",
"version": "2.0.0",
"isBuiltin": true,
"enabled": true,
"missing": true,
"hasIcon": true,
"createdAt": "<string>",
"autoUpdate": true,
"autoUpdateConstraint": "<string>",
"hash": "<string>",
"source": "<string>",
"configSchema": {},
"secretsSchema": {}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "rate_limit_exceeded",
"message": "<string>",
"retryAfter": 1
}{
"error": "<string>",
"code": "<string>"
}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 --request GET \
--url http://localhost:9371/modules/{moduleId}import requests
url = "http://localhost:9371/modules/{moduleId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:9371/modules/{moduleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "9371",
CURLOPT_URL => "http://localhost:9371/modules/{moduleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:9371/modules/{moduleId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:9371/modules/{moduleId}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9371/modules/{moduleId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"type": "adapter",
"description": "<string>",
"version": "2.0.0",
"isBuiltin": true,
"enabled": true,
"missing": true,
"hasIcon": true,
"createdAt": "<string>",
"autoUpdate": true,
"autoUpdateConstraint": "<string>",
"hash": "<string>",
"source": "<string>",
"configSchema": {},
"secretsSchema": {}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "rate_limit_exceeded",
"message": "<string>",
"retryAfter": 1
}{
"error": "<string>",
"code": "<string>"
}Path Parameters
Module identifier.
Minimum string length:
1Response
Full module manifest record.
Full module manifest record returned by the get module endpoint.
Module identifier.
Minimum string length:
1Module display name.
Minimum string length:
1Module type.
Available options:
adapter, environment Human-readable description of the module.
Semantic version of the installed module manifest.
Minimum string length:
1Example:
"2.0.0"
Whether the module is bundled with the API.
Whether the module is currently enabled.
Whether the module is installed but has no matching factory loaded.
Whether the module has a registry-declared icon.
ISO-8601 timestamp of when the module was installed.
Whether the module opted into the background auto-update sweep.
Semver range pinning the auto-update registry version, or null for latest.
Content hash of the installed module archive.
Minimum string length:
1Install source URL used to fetch the module archive.
JSON Schema describing the module configuration object.
Show child attributes
Show child attributes
JSON Schema describing the module secrets object.
Show child attributes
Show child attributes
Last modified on August 25, 2026
Was this page helpful?