Install a catalog entry into the caller's tenant
curl --request POST \
--url https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auth": {
"header": "<string>",
"apiKey": {
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>",
"header": "<string>",
"value": "<string>"
},
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>"
},
"urlVariables": {
"baseUrl": "https://gitlab.acme.io"
},
"name": "<string>"
}
'import requests
url = "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install"
payload = {
"auth": {
"header": "<string>",
"apiKey": {
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>",
"header": "<string>",
"value": "<string>"
},
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>"
},
"urlVariables": { "baseUrl": "https://gitlab.acme.io" },
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth: {
header: '<string>',
apiKey: {
apiKeyValue: '<string>',
apiKeyHeader: '<string>',
header: '<string>',
value: '<string>'
},
apiKeyValue: '<string>',
apiKeyHeader: '<string>'
},
urlVariables: {baseUrl: 'https://gitlab.acme.io'},
name: '<string>'
})
};
fetch('https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'auth' => [
'header' => '<string>',
'apiKey' => [
'apiKeyValue' => '<string>',
'apiKeyHeader' => '<string>',
'header' => '<string>',
'value' => '<string>'
],
'apiKeyValue' => '<string>',
'apiKeyHeader' => '<string>'
],
'urlVariables' => [
'baseUrl' => 'https://gitlab.acme.io'
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install"
payload := strings.NewReader("{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mcpServerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}MCP Servers
Install a catalog entry into the caller's tenant
Security Requirements
| Auth Types | Entities | Permissions | Required Roles |
|---|---|---|---|
| USER | MCP_REGISTRY | WRITE | MCP_REGISTRY:WRITE |
POST
/
registry
/
v1
/
marketplace
/
catalog
/
{slug}
/
install
Install a catalog entry into the caller's tenant
curl --request POST \
--url https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"auth": {
"header": "<string>",
"apiKey": {
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>",
"header": "<string>",
"value": "<string>"
},
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>"
},
"urlVariables": {
"baseUrl": "https://gitlab.acme.io"
},
"name": "<string>"
}
'import requests
url = "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install"
payload = {
"auth": {
"header": "<string>",
"apiKey": {
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>",
"header": "<string>",
"value": "<string>"
},
"apiKeyValue": "<string>",
"apiKeyHeader": "<string>"
},
"urlVariables": { "baseUrl": "https://gitlab.acme.io" },
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth: {
header: '<string>',
apiKey: {
apiKeyValue: '<string>',
apiKeyHeader: '<string>',
header: '<string>',
value: '<string>'
},
apiKeyValue: '<string>',
apiKeyHeader: '<string>'
},
urlVariables: {baseUrl: 'https://gitlab.acme.io'},
name: '<string>'
})
};
fetch('https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'auth' => [
'header' => '<string>',
'apiKey' => [
'apiKeyValue' => '<string>',
'apiKeyHeader' => '<string>',
'header' => '<string>',
'value' => '<string>'
],
'apiKeyValue' => '<string>',
'apiKeyHeader' => '<string>'
],
'urlVariables' => [
'baseUrl' => 'https://gitlab.acme.io'
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install"
payload := strings.NewReader("{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.swarmd.ai/registry/v1/marketplace/catalog/{slug}/install")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth\": {\n \"header\": \"<string>\",\n \"apiKey\": {\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\",\n \"header\": \"<string>\",\n \"value\": \"<string>\"\n },\n \"apiKeyValue\": \"<string>\",\n \"apiKeyHeader\": \"<string>\"\n },\n \"urlVariables\": {\n \"baseUrl\": \"https://gitlab.acme.io\"\n },\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"mcpServerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
JWT token (USER, AGENT, or SERVICE auth)
Path Parameters
Body
application/json
Install a catalog entry into the caller's tenant. The auth payload supplies tenant-specific credentials (or DCR opt-in for OAuth2 auth-code) on top of the catalog template.
Resolved auth credentials for a subscription. Secret values are encrypted at rest.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Values to substitute into the catalog entry's urlTemplate. Required for catalog entries that declare urlVariables (e.g. GitLab self-hosted baseUrl, Atlassian subdomain). Ignored when the catalog entry has no urlTemplate.
Show child attributes
Show child attributes
Example:
{ "baseUrl": "https://gitlab.acme.io" }
Optional display name to use for the installed mcp_servers row. Falls back to the catalog entry's display_name (auto-suffixed on collision) when blank or omitted.
Response
201 - */*
Created
